---
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​Metafieldshook

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
  ```

```ts
interface AppMetafieldFilters {
  id?: AppMetafieldEntryTarget['id'];
  type?: AppMetafieldEntryTarget['type'];
  namespace?: Metafield['namespace'];
  key?: Metafield['key'];
}
```

### 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
  ```

```ts
export interface AppMetafieldEntry {
  /**
   * 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`.
   */
  target: AppMetafieldEntryTarget;

  /** The metadata information. */
  metafield: 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
  ```

```ts
export interface AppMetafieldEntryTarget {
  /**
   * 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`.
   */
  type:
    | 'customer'
    | 'product'
    | 'shop'
    | 'variant'
    | 'company'
    | 'companyLocation'
    | 'cart';

  /** The numeric owner ID that is associated with the metafield. */
  id: 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
  ```

```ts
export interface AppMetafield {
  /** The key name of a metafield. */
  key: string;

  /** The namespace for a metafield. */
  namespace: string;

  /** The value of a metafield. */
  value: string | number | boolean;

  /** The metafield’s information type. */
  valueType: 'boolean' | 'float' | 'integer' | 'json_string' | 'string';

  /** The metafield's type name. */
  type: string;
}
```

## Related

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/orderstatusapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlineitemapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointlistapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationlistapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingoptionitemapi)

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

[![](https://shopify.dev/images/icons/32/pickaxe-1.png)![](https://shopify.dev/images/icons/32/pickaxe-1-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensiontargets)

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