Skip to content

List metafields

View as Markdown
get /api/{ownerResource}/{ownerId}/metafields

Retrieves the collection of Metafield resources.

Returns the metafields stored on a single owner record, identified by ownerResource (such as products) and ownerId. Set Flowkiwi-Locale to read translatable values in a given locale.

Headers

NameTypeRequiredDescription
Flowkiwi-Localestring-Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

NameTypeRequiredDescription
ownerResourcestringrequiredThe owner resource type the metafields are scoped to (e.g. "products", "variants"); must match the definition's ownerType.
ownerIdstringrequiredThe id of the owner record the metafields belong to.

Query parameters

NameTypeRequiredDescription
pageinteger-The collection page number
itemsPerPageinteger-The number of items per page

Response

200 - Metafield collection

PropertyTypeRequiredDescription
totalItemsinteger-
searchobject-
Show search fields
PropertyTypeRequiredDescription
@typestring-
templatestring-
variableRepresentationstring-
mappingobject[]-
Show mapping fields
PropertyTypeRequiredDescription
@typestring-
variablestring-
propertystring | null-
requiredboolean-
viewobject-
Show view fields
PropertyTypeRequiredDescription
@idstring-
@typestring-
firststring | null-
laststring | null-
previousstring | null-
nextstring | null-
memberMetafield[]required
Show member fields
PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The resource's unique identifier (UUID).
valuestring-This property supports translations.

The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
ownerIdstring | null-The id of the owner record the metafield is attached to.
definitionstring-The MetafieldDefinition this metafield is an instance of.
ownerResourcestringrequiredThe type of resource that the metafield is attached to.
metaobjectstring[]-The referenced metaobject(s). Populated when ?expand=metaobject is requested and the field type is metaobject_reference or list__metaobject_reference.
createdAtstring-The date and time when the resource was created (ISO 8601 format).
updatedAtstring-The date and time when the resource was last modified (ISO 8601 format).

Errors

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

Content-Type: application/problem+json

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
typestring-
titlestring-
statusinteger-
detailstring-
missingPermissionsstring[]-Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.