Job

object

A job corresponds to some long running task that the client should poll for status.

Anchor to FieldsFields

Anchor to donedone • Boolean!non-null: This indicates if the job is still queued or has been run.
Anchor to idid • ID!non-null: A globally-unique ID that's returned when running an asynchronous mutation.
Anchor to queryquery • QueryRoot: 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.

Was this section helpful?

Anchor to QueriesQueries

Anchor to job job • query: Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

Was this section helpful?

Anchor to MutationsMutations

Anchor to collectionAddProductsV2 collectionAddProductsV2 • mutation: 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.
Anchor to collectionRemoveProducts collectionRemoveProducts • mutation: 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.
Anchor to collectionReorderProducts collectionReorderProducts • mutation: 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 Collection.sortOrder must be MANUAL. Displaced products will have their position altered in a consistent manner, with no gaps.
Anchor to collectionUpdate collectionUpdate • mutation: Updates a collection.
Anchor to customerMerge customerMerge • mutation: Merges two customers.
Anchor to deliveryProfileRemove deliveryProfileRemove • mutation: Enqueue the removal of a delivery profile.
Anchor to discountAutomaticBulkDelete discountAutomaticBulkDelete • mutation: Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument 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 blank search argument is provided.
Anchor to discountCodeBulkActivate discountCodeBulkActivate • mutation: Activates multiple code discounts asynchronously using one of the following:

A search query

A saved search ID

A list of discount code IDs

For example, you can activate discounts for all codes that match a search criteria, or activate a predefined set of discount codes.
Anchor to discountCodeBulkDeactivate discountCodeBulkDeactivate • mutation: Deactivates multiple code-based discounts asynchronously using one of the following:

A search query

A saved search ID

A list of discount code IDs

For example, you can deactivate discounts for all codes that match a search criteria, or deactivate a predefined set of discount codes.
Anchor to discountCodeBulkDelete discountCodeBulkDelete • mutation: Deletes multiple code-based discounts asynchronously using one of the following:

A search query

A saved search ID

A list of discount code IDs

For example, you can delete discounts for all codes that match a search criteria, or delete a predefined set of discount codes.
Anchor to discountCodeRedeemCodeBulkDelete discountCodeRedeemCodeBulkDelete • mutation: Asynchronously delete discount codes in bulk that customers can use to redeem a discount.
Anchor to draftOrderBulkAddTags draftOrderBulkAddTags • mutation: Adds tags to multiple draft orders.
Anchor to draftOrderBulkDelete draftOrderBulkDelete • mutation: Deletes multiple draft orders.
Anchor to draftOrderBulkRemoveTags draftOrderBulkRemoveTags • mutation: Removes tags from multiple draft orders.
Anchor to marketingActivitiesDeleteAllExternal marketingActivitiesDeleteAllExternal • mutation: 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.
Anchor to metafieldDefinitionUpdate metafieldDefinitionUpdate • mutation: Updates a metafield definition.
Anchor to metaobjectBulkDelete metaobjectBulkDelete • mutation: Asynchronously delete metaobjects and their associated metafields in bulk.
Anchor to orderCancel orderCancel • mutation: Cancels an order.
Anchor to orderCreateMandatePayment orderCreateMandatePayment • mutation: Creates a payment for an order by mandate.
Anchor to productDuplicate productDuplicate • mutation: 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: false argument in this mutation to perform the duplication asynchronously.

In API version 2024-07 and lower, use the asynchronous ProductDuplicateAsyncV2.

Metafield values are not duplicated if the unique values capability is enabled.
Anchor to productReorderMedia productReorderMedia • mutation: Asynchronously reorders the media attached to a product.
Anchor to urlRedirectBulkDeleteAll urlRedirectBulkDeleteAll • mutation: Asynchronously delete URL redirects in bulk.
Anchor to urlRedirectBulkDeleteByIds urlRedirectBulkDeleteByIds • mutation: Asynchronously delete URLRedirect objects in bulk by IDs. Learn more about URLRedirect objects.
Anchor to urlRedirectBulkDeleteBySavedSearch urlRedirectBulkDeleteBySavedSearch • mutation: Asynchronously delete redirects in bulk.
Anchor to urlRedirectBulkDeleteBySearch urlRedirectBulkDeleteBySearch • mutation: Asynchronously delete redirects in bulk.
Anchor to urlRedirectImportSubmit urlRedirectImportSubmit • mutation: Submits a UrlRedirectImport request to be processed.

The UrlRedirectImport request is first created with the urlRedirectImportCreate mutation.

Show

deprecated mutations Deprecated

Anchor to fulfillmentOrdersReleaseHolds fulfillmentOrdersReleaseHolds • mutationDeprecated: Releases the fulfillment holds on a list of fulfillment orders. This mutation is deprecated and will be removed in the 2024-10 API version. Consider using the fulfillmentOrderReleaseHold mutation instead.
Anchor to productDeleteAsync productDeleteAsync • mutationDeprecated: Deletes a product asynchronously, including all associated variants and media. Use productDelete instead.
Anchor to productReorderImages productReorderImages • mutationDeprecated: Asynchronously reorders a set of images for a given product. Use productReorderMedia instead.

Was this section helpful?