Metafield
The input fields to use to create or update a metafield through a mutation on the owning resource. An alternative way to create or update a metafield is by using the metafieldsSet mutation.
Anchor to FieldsFields
- •ID
The unique ID of the metafield. Using
,namespace, andkeyis preferred for creating and updating.- •String
The unique identifier for a metafield within its namespace.
Required when creating a metafield, but optional when updating. Used to help identify the metafield when updating, but can't be updated itself.
Must be 2-64 characters long and can contain alphanumeric, hyphen, and underscore characters.
- Anchor to namespacenamespace•String
The container for a group of metafields that the metafield is or will be associated with. Used in tandem with
keyto lookup a metafield on a resource, preventing conflicts with other metafields with the samekey.Required when creating a metafield, but optional when updating. Used to help identify the metafield when updating, but can't be updated itself.
Must be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.
- Anchor to typetype•String
The type of data that is stored in the metafield. Refer to the list of supported types.
Required when creating or updating a metafield without a definition.
- Anchor to valuevalue•String
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
- Anchor to descriptiondescription•StringDeprecated
Anchor to Input objects using this inputInput objects using this input
- •INPUT OBJECT
The input fields to create an article.
- •INPUT OBJECT
The input fields to update an article.
- •INPUT OBJECT
The input fields to create a blog.
- •INPUT OBJECT
The input fields to update a blog.
- •INPUT OBJECT
The input fields required to create a collection.
- •INPUT OBJECT
The input fields and values to use when creating or updating a customer.
- •INPUT OBJECT
The input fields to create and update a delivery customization.
- •INPUT OBJECT
The input fields for creating or updating an automatic discount that's managed by an app.
Use these input fields when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.
- •INPUT OBJECT
The input fields for creating or updating a code discount, where the discount type is provided by an app extension that uses Shopify Functions.
Use these input fields when you need advanced or custom discount capabilities that aren't supported by Shopify's native discount types.
- •INPUT OBJECT
The input fields used to create or update a draft order.
- •INPUT OBJECT
The input fields to use to add a location.
- •INPUT OBJECT
The input fields to use to edit a location.
- •INPUT OBJECT
The input fields for creating an order.
- •INPUT OBJECT
The input fields for specifying the information to be updated on an order when using the orderUpdate mutation.
- •INPUT OBJECT
The input fields to create a page.
- •INPUT OBJECT
The input fields to update a page.
- •INPUT OBJECT
The input fields to create and update a payment customization.
- •INPUT OBJECT
The input fields required to create a product.
- •INPUT OBJECT
The input fields for creating or updating a product.
- •INPUT OBJECT
The input fields required to create or update a product via ProductSet mutation.
- •INPUT OBJECT
The input fields for updating a product.
- •INPUT OBJECT
The input fields for specifying a product variant to create or update.
- •INPUT OBJECT
The input fields for specifying a product variant to create as part of a variant bulk mutation.
- •INPUT OBJECT
The input fields to create or update a selling plan.
- •INPUT OBJECT
The input fields required to install a validation.
- •INPUT OBJECT
The input fields required to update a validation.