MetafieldInput
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
- •
The unique ID of the metafield. Using
,namespace, andkeyis preferred for creating and updating.- •
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•
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•
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•
The data stored in the metafield. Always stored as a string, regardless of the metafield's type.
- Anchor to descriptiondescription•StringDeprecated
The description of the metafield. Use metafield definitions to set descriptions instead. The corresponding input field is available on MetafieldDefinitionInput when creating metafield definitions and MetafieldDefinitionUpdateInput when updating.
Anchor to Input objects using this inputInput objects using this input
- •INPUT OBJECT
The metafields to associate with the collection.
- •INPUT OBJECT
Additional metafields to associate to the customer.
- •INPUT OBJECT
Additional metafields to associate to the delivery customization.
- •INPUT OBJECT
Additional metafields to associate to the discount. Metafields provide dynamic function configuration with different parameters, such as
percentagefor a percentage discount. Merchants can set metafield values in the Shopify admin, which makes the discount function more flexible and customizable.- •INPUT OBJECT
Additional metafields to associate to the discount. Metafields provide dynamic function configuration with different parameters, such as
percentagefor a percentage discount. Merchants can set metafield values in the Shopify admin, which makes the discount function more flexible and customizable.- •INPUT OBJECT
The list of metafields attached to the draft order. An existing metafield can not be used when creating a draft order.
- •INPUT OBJECT
Additional customizable information to associate with the location.
- •INPUT OBJECT
Additional customizable information to associate with the location.
- •INPUT OBJECT
A list of new metafields to add to the existing metafields for the order.
- •INPUT OBJECT
Additional metafields to associate to the payment customization.
- •INPUT OBJECT
The custom fields to associate with the product for the purposes of adding and storing additional information.
- •INPUT OBJECT
The metafields to associate with this product.
- •INPUT OBJECT
Additional customizable information about the product variant.
- •INPUT OBJECT
Additional customizable information about the product variant.
- •INPUT OBJECT
The additional customizable information about the product variant.
- •INPUT OBJECT
Additional metafields to associate to the validation.
- •INPUT OBJECT
Additional metafields to associate to the validation.