For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

GraphQL Storefront Types Objects

Metafields

OBJECT

Definition

1 type Metafields {
2   id: String!
3   entityId: Int!
4   key: String!
5   value: String!
6   description: String!
7 }

Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.)

Was this page helpful?

MetaPixelProvider

Fields

idStringRequired

The ID of metafield.

entityIdIntegerRequired

The ID of the metafield when referencing via our backend API.

keyStringRequired

A label for identifying metafield's data value.

valueStringRequired

A metafield's value.

descriptionStringRequired

A metafield's description.

Referenced by

Fields

CreateCartMetafieldResult.metafield
MetafieldEdge.node
UpdateCartMetafieldResult.metafield