Metafields enable you to attach additional information to a Shopify resource, such as a Product or a Collection. For more information about where you can attach metafields refer to HasMetafields. Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers. Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value.
Fields and connections
The data stored in the resource, represented as a digest.
The date and time when the metafield was created.
The metafield definition that the metafield belongs to, if any.
The description of the metafield.
A globally-unique ID.
The data stored in the metafield in JSON format.
The unique identifier for the metafield within its namespace.
The ID of the corresponding resource in the REST Admin API.
The container for a group of metafields that the metafield is associated with.
The resource that the metafield is attached to.
The type of resource that the metafield is attached to.
Returns a reference object if the metafield definition's type is a resource reference.
A list of reference objects if the metafield's type is a resource reference list.
The type of data that is stored in the metafield. Refer to the list of supported types.
The date and time when the metafield was updated.
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
Mutations
Sets metafield values. Metafield values will be set regardless if they were previously created or not.
Allows a maximum of 25 metafields to be set at a time.
This operation is atomic, meaning no changes are persisted if an error is encountered.
As of
2024-07, this operation supports compare-and-set functionality to better handle concurrent requests. Ifis set for any metafield, the mutation will only set that metafield if the persisted metafield value matches the digest used on. If the metafield doesn't exist yet, but you want to guarantee that the operation will run in a safe manner, settonull. Thevalue can be acquired by querying the metafield object and selectingas a field. If thevalue does not match the digest for the persisted value, the mutation will return an error. You can opt out of write guarantees by not sendingin the request.