Product
Defines errors for ProductSet mutation.
Anchor to FieldsFields
- Anchor to codecode•Product
Set User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Performs multiple operations to create or update products in a single request.
Use the
mutation to sync information from an external data source into Shopify, manage large product catalogs, and perform batch updates. The mutation is helpful for bulk product management, including price adjustments, inventory updates, and product lifecycle management.The behavior of
depends on the type of field it's modifying:For list fields: Creates new entries, updates existing entries, and deletes existing entries that aren't included in the mutation's input. Common examples of list fields include
collections,metafields, andvariants.For all other field types: Updates only the included fields. Any omitted fields will remain unchanged.
NoteBy default, stores have a limit of 100 product variants for each product. You can create a development store and enable the Extended Variants developer preview to create or update a maximum of 2,048 product variants in a single operation.
You can run
in one of the following modes:- Synchronously: Returns the updated product in the response.
- Asynchronously: Returns a
object. Use thequery to check the status of the operation and retrieve details of the updated product and its product variants.
If you need to only manage product variants, then use one of the following mutations:
If you need to only manage product options, then use one of the following mutations:
Learn more about syncing product data from an external source.
- Anchor to inputinput•Product
Set Input! required The properties of the newly created or updated product.
- Anchor to synchronoussynchronous•BooleanDefault:true
Whether the mutation should be run synchronously or asynchronously.
If
true, the mutation will return the updatedproduct.If
false, the mutation will return a.Defaults to
true.Setting
synchronous: falsemay be desirable depending on the input complexity/size, and should be used if you are experiencing timeouts.Note: When run in the context of a bulk operation, the mutation will always run synchronously and this argument will be ignored.
Arguments
- Anchor to productproduct•Product
The product object.
- Anchor to productSetOperationproduct•Product
Set Operation Set Operation The product set operation, returned when run in asynchronous mode.
- Anchor to userErrorsuser•[Product
Errors Set User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields