---
title: useAppMetafields
description: Returns the metafields configured with `shopify.extension.toml`.
api_version: 2023-07
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2023-07/react-hooks/metafields/useappmetafields
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2023-07/react-hooks/metafields/useappmetafields.md
---

# use​App​Metafields

Returns the metafields configured with `shopify.extension.toml`.

## use​App​Metafields(**[filters](#-propertydetail-filters)**​)

### Parameters

* **filters**

  **AppMetafieldFilters**

  **Default: {}**

### Returns

* **AppMetafieldEntry\[]**

### AppMetafieldFilters

* id

  ```ts
  string
  ```

* type

  ```ts
  "shop" | "customer" | "product" | "variant" | "company" | "companyLocation" | "cart"
  ```

* namespace

  ```ts
  string
  ```

* key

  ```ts
  string
  ```

### AppMetafieldEntry

A metafield associated with the shop or a resource on the checkout.

* target

  The target that is associated to the metadata. {% include /apps/checkout/privacy-icon.md %} Requires access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data) when the type is \`customer\`, \`company\` or \`companyLocation\`.

  ```ts
  AppMetafieldEntryTarget
  ```

* metafield

  The metadata information.

  ```ts
  AppMetafield
  ```

### AppMetafieldEntryTarget

The metafield owner.

* type

  The type of the metafield owner. {% include /apps/checkout/privacy-icon.md %} Requires access to \[protected customer data]\(/docs/apps/store/data-protection/protected-customer-data) when the type is \`customer\`, \`company\` or \`companyLocation\`.

  ```ts
  "cart" | "shop" | "customer" | "product" | "variant" | "company" | "companyLocation"
  ```

* id

  The numeric owner ID that is associated with the metafield.

  ```ts
  string
  ```

### AppMetafield

Represents a custom metadata attached to a resource.

* key

  The key name of a metafield.

  ```ts
  string
  ```

* namespace

  The namespace for a metafield.

  ```ts
  string
  ```

* value

  The value of a metafield.

  ```ts
  string | number | boolean
  ```

* valueType

  The metafield’s information type.

  ```ts
  "string" | "boolean" | "integer" | "json_string" | "float"
  ```

* type

  The metafield's type name.

  ```ts
  string
  ```

## Related

[APIs - StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)

[APIs - CheckoutApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)

[APIs - OrderStatusApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/orderstatusapi)

[APIs - CartLineItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlineitemapi)

[APIs - PickupPointListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointlistapi)

[APIs - PickupLocationListApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationlistapi)

[APIs - ShippingOptionItemApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingoptionitemapi)

[APIs - ExtensionTargets](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets)