Metafield
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.
Anchor to FieldsFields
- Anchor to compareDigestcompare•String!
Digest non-null The data stored in the resource, represented as a digest.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the metafield was created.
- Anchor to definitiondefinition•Metafield
Definition The metafield definition that the metafield belongs to, if any.
- •ID!non-null
A globally-unique ID.
- Anchor to jsonValuejson•JSON!
Value non-null The data stored in the metafield in JSON format.
- •String!non-null
The unique identifier for the metafield within its namespace.
- Anchor to legacyResourceIdlegacy•Unsigned
Resource Id Int64! non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to namespacenamespace•String!non-null
The container for a group of metafields that the metafield is associated with.
- Anchor to ownerowner•Has
Metafields! non-null The resource that the metafield is attached to.
- Anchor to ownerTypeowner•Metafield
Type Owner Type! non-null The type of resource that the metafield is attached to.
- Anchor to referencereference•Metafield
Reference Returns a reference object if the metafield definition's type is a resource reference.
- Anchor to referencesreferences•Metafield
Reference Connection A list of reference objects if the metafield's type is a resource reference list.
- Anchor to typetype•String!non-null
The type of data that is stored in the metafield. Refer to the list of supported types.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the metafield was updated.
- Anchor to valuevalue•String!non-null
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
- Anchor to descriptiondescription•StringDeprecated
Anchor to MutationsMutations
- •mutation
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, with a maximum total request payload size of 10MB.
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.