List resolved metafields

get /api/{ownerResource}/{ownerId}/resolved-metafields

Retrieves the collection of ResolvedMetafield resources.

Returns every metafield definition that applies to the owner’s resource type, each paired with the owner’s metafield value, or null when the record has no value yet. The owner is identified by ownerResource (such as products) and ownerId. It is designed to render a metafields edit form in a single call. This endpoint is only available in the unstable version.

Path parameters

Name	Type	Required	Description
ownerResource	string	required	MetafieldResource identifier
ownerId	string	required	MetafieldResource identifier

Query parameters

Name	Type	Required	Description
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - ResolvedMetafield collection

Property	Type	Required	Description
search	object	-
Show search fields Property Type Required Description @type string - mapping object[] - Show mapping fields Property Type Required Description @type string - property string | null - required boolean - variable string - template string - variableRepresentation string -
totalItems	integer	-
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string | null - last string | null - next string | null - previous string | null -
member	ResolvedMetafield[]	required
Show member fields Property Type Required Description @context string | object - @id string required @type string required definition MetafieldDefinition | null - The metafield definition applicable to the owner resource type. Requires the metafields:read scope. Returned null when the scope is missing. Show definition fields Property Type Required Description @context string | object - @id string required @type string required constraints EmbeddedMetafieldDefinitionConstraintResource[] - The constraint rules scoping where this metafield definition applies (e.g. by category or channel). createdAt string - The date and time when the resource was created (ISO 8601 format). description string | null - The description of the metafield definition. id string - The resource's unique identifier (UUID). key string - The unique identifier for the metafield definition within its namespace. metafieldsCount integer - The count of the metafields that belong to the metafield definition. name string - The human-readable name of the metafield definition. namespace string - The container for a group of metafields that the metafield definition is associated with. ownerType "/api/metafield_owner_types/products" | "/api/metafield_owner_types/collections" | "/api/metafield_owner_types/variants" | "/api/metafield_owner_types/sale_offers" | "/api/metafield_owner_types/purchase_offers" required The resource type that the metafield definition is attached to. type "/api/metafield_definition_types/single_line_text_field" | "/api/metafield_definition_types/multi_line_text_field" | "/api/metafield_definition_types/number_integer" | "/api/metafield_definition_types/number_decimal" | "/api/metafield_definition_types/json" | "/api/metafield_definition_types/list__single_line_text_field" | "/api/metafield_definition_types/list__number_integer" | "/api/metafield_definition_types/list__number_decimal" | "/api/metafield_definition_types/list__product_reference" | "/api/metafield_definition_types/list__media_reference" | "/api/metafield_definition_types/product_reference" | "/api/metafield_definition_types/media_reference" | "/api/metafield_definition_types/metaobject_reference" | "/api/metafield_definition_types/list__metaobject_reference" required The type of data that each of the metafields that belong to the metafield definition will store. updatedAt string - The date and time when the resource was last modified (ISO 8601 format). validations EmbeddedMetafieldDefinitionValidationResource[] - The validation rules applied to the values of metafields using this definition. id string - The metafield definition id. metafield Metafield | null - The owner's metafield for this definition, or null when the owner has no value yet. Requires the metafields:read scope. Returned null when the scope is missing. Show metafield fields Property Type Required Description @context string | object - @id string required @type string required createdAt string - The date and time when the resource was created (ISO 8601 format). definition string | null - The MetafieldDefinition this metafield is an instance of. Requires the metafields:read scope. Returned null when the scope is missing. id string - The resource's unique identifier (UUID). metaobject array - The referenced metaobject(s). Populated when ?expand=metaobject is requested and the field type is metaobject_reference or list__metaobject_reference. Requires the metaobjects:read scope. Returned empty when the scope is missing. ownerId string | null - The id of the owner record the metafield is attached to. ownerResource string required The type of resource that the metafield is attached to. updatedAt string - The date and time when the resource was last modified (ISO 8601 format). value string - This property supports translations. The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-