Returns the metafields stored on a single owner record, identified by ownerResource (such as products) and ownerId. Set X-Flowkiwi-Locale to read translatable values in a given locale.
Headers
Name
Type
Required
Description
X-Flowkiwi-Organization-Id
string
required
The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.
X-Flowkiwi-Locale
string
-
Specifies the locale for properties that support localization. If not provided, the default locale will be used.
X-Flowkiwi-Locale-Fallback
boolean
-
Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from the default locale will be used.
Path parameters
Name
Type
Required
Description
ownerResource
string
required
The owner resource type the metafields are scoped to (e.g. "products", "variants"); must match the definition's ownerType.
ownerId
string
required
The id of the owner record the metafields belong to.
Query parameters
Name
Type
Required
Description
page
integer
-
The collection page number
itemsPerPage
integer
-
The number of items per page
Response
200 - Metafield collection
Property
Type
Required
Description
hydra:totalItems
integer
-
hydra:search
object
-
Show hydra:search fields
Property
Type
Required
Description
@type
string
-
hydra:template
string
-
hydra:variableRepresentation
string
-
hydra:mapping
object[]
-
Show hydra:mapping fields
Property
Type
Required
Description
@type
string
-
variable
string
-
property
string | null
-
required
boolean
-
hydra:view
object
-
Show hydra:view fields
Property
Type
Required
Description
@id
string
-
@type
string
-
hydra:first
string
-
hydra:last
string
-
hydra:previous
string
-
hydra:next
string
-
hydra:member
Metafield[]
required
Show hydra:member fields
Property
Type
Required
Description
@context
object
-
@id
string
required
@type
string
required
id
string
-
The resource's unique identifier (UUID).
value
string
-
This property supports translations.
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
ownerId
string | null
-
The id of the owner record the metafield is attached to.
definition
string
-
The MetafieldDefinition this metafield is an instance of.
ownerResource
string
required
The type of resource that the metafield is attached to.
metaobject
string[]
-
The referenced metaobject(s). Populated when ?expand=metaobject is requested and the field type is metaobject_reference or list__metaobject_reference.
createdAt
string
-
The date and time when the resource was created (ISO 8601 format).
updatedAt
string
-
The date and time when the resource was last modified (ISO 8601 format).
No properties.
Errors
403 - Access denied. The caller is missing one or more identity permissions required for this operation.
Content-Type:application/problem+json
Property
Type
Required
Description
@context
object
-
@id
string
required
@type
string
required
type
string
-
title
string
-
status
integer
-
detail
string
-
missingPermissions
string[]
-
Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.