A job corresponds to some long running task that the client should poll for status.
This indicates if the job is still queued or has been run.
A globally-unique ID that's returned when running an asynchronous mutation.
This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job.
- Anchor to jobquery
Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.
Mutations
Asynchronously adds a set of products to a given collection. It can take a long time to run. Instead of returning a collection, it returns a job which should be polled.
Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be polled. For use with manual collections only.
Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The
must be. Displaced products will have their position altered in a consistent manner, with no gaps.Updates a collection.
Merges two customers.
Enqueue the removal of a delivery profile.
Asynchronously delete automatic discounts in bulk if a
searchorargument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blanksearchargument is provided.Asynchronously activate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.
Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.
Asynchronously delete code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.
Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a saved search ID, or a list of redeem code IDs.
Adds tags to multiple draft orders.
Deletes multiple draft orders.
Removes tags from multiple draft orders.
Deletes all external marketing activities. Deletion is performed by a background job, as it may take a bit of time to complete if a large number of activities are to be deleted. Attempting to create or modify external activities before the job has completed will result in the create/update/upsert mutation returning an error.
Updates a metafield definition.
Asynchronously delete metaobjects and their associated metafields in bulk.
Cancels an order.
Creates a payment for an order by mandate.
Duplicates a product.
If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.
To avoid these timeout errors, you can instead duplicate the product asynchronously.
In API version 2024-10 and higher, include
synchronous: falseargument in this mutation to perform the duplication asynchronously.Asynchronously reorders the media attached to a product.
Asynchronously queries and charges all subscription billing cycles whose billingAttemptExpectedDate values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the subscriptionBillingCycleBulkResults query.
Asynchronously queries all subscription billing cycles whose billingAttemptExpectedDate values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the subscriptionBillingCycleBulkResults query.
Asynchronously delete URL redirects in bulk.
Asynchronously delete URLRedirect objects in bulk by IDs. Learn more about URLRedirect objects.
Asynchronously delete redirects in bulk.
Asynchronously delete redirects in bulk.