A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to shopifyFunctionshopifyFunction

•ShopifyFunction!

non-null

The Shopify Function implementing the delivery customization.

Anchor to titletitle

•String!

non-null

The title of the delivery customization.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to QueriesQueries

Anchor to deliveryCustomization deliveryCustomization

•query

The delivery customization.

Anchor to idid •ID! required: The ID of the delivery customization.

Anchor to deliveryCustomizations deliveryCustomizations

•query

The delivery customizations.

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.