Job

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.

Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

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 multiple products from a collection in a single operation. This mutation can process large product sets (up to 250 products) and may take significant time to complete for collections with many products.

For example, when ending a seasonal promotion, merchants can remove all sale items from a "Summer Clearance" collection at once rather than editing each product individually.

Use CollectionRemoveProducts to:

• Bulk-remove products from collections efficiently
• Clean up collection membership during catalog updates
• Implement automated collection management workflows

The operation processes asynchronously to avoid timeouts and performance issues, especially for large product sets.

Learn more about collection management.

Asynchronously reorders 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.

How to use this mutation:

• Provide only the products that actually moved in the moves list; do not send the entire product list. For example: to move the product at index 1 to index N, send a single move for that product with newPosition: N.
• Each move is applied sequentially in the order provided.
• newPosition is a zero-based index within the collection at the moment the move is applied (after any prior moves in the list).
• Products not included in moves keep their relative order, aside from any displacement caused by the moves.
• If newPosition is greater than or equal to the number of products, the product is placed at the end.

Example:

• Initial order: [A, B, C, D, E] (indices 0..4)
• Moves (applied in order):
• E -> newPosition: 1
• C -> newPosition: 4
• Result: [A, E, B, D, C]

Displaced products will have their position altered in a consistent manner with no gaps.

Updates a collection, modifying its properties, products, or publication settings. Collections help organize products together in the online store and other sales channels.

Use the collectionUpdate mutation to programmatically modify collections in scenarios such as:

• Updating collection details, like title, description, or image
• Modifying SEO metadata for better search visibility
• Changing which products are included (using rule updates for smart collections)
• Publishing or unpublishing collections across different sales channels
• Updating custom data using metafields

There are two types of collections with different update capabilities:

• Custom (manual) collections: You can update collection properties, but rule sets can't be modified since products are manually selected.
• Smart (automated) collections: You can update both collection properties and the rules that automatically determine which products are included. When updating rule sets for smart collections, the operation might be processed asynchronously. In these cases, the mutation returns a job object that you can use to track the progress of the update.

To publish or unpublish collections to specific sales channels, use the dedicated publishablePublish and publishableUnpublish mutations.

Learn more about using metafields with smart collections.

Merges two customers.

Enqueue the removal of a delivery profile.

Deletes multiple automatic discounts in a single operation, providing efficient bulk management for stores with extensive discount catalogs. This mutation processes deletions asynchronously to handle large volumes without blocking other operations.

For example, when cleaning up expired seasonal promotions or removing outdated automatic discounts across product categories, merchants can delete dozens of discounts simultaneously rather than processing each individually.

Use DiscountAutomaticBulkDelete to:

• Remove multiple automatic discounts efficiently
• Clean up expired or obsolete promotions
• Streamline discount management workflows
• Process large-scale discount removals asynchronously

The operation returns a job object for tracking deletion progress and any validation errors encountered during processing.

Learn more about discount management.

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.

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.

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.

Asynchronously delete discount codes in bulk that customers can use to redeem a discount.

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, with options for refunding, restocking inventory, and customer notification.

---

---

Use the orderCancel mutation to programmatically cancel orders in scenarios such as:

• Customer-requested cancellations due to size, color, or other preference changes
• Payment processing failures or declined transactions
• Fraud detection and prevention
• Insufficient inventory availability
• Staff errors in order processing
• Wholesale or B2B order management workflows

The orderCancel mutation provides flexible refund options including refunding to original payment methods or issuing store credit. If a payment was only authorized (temporarily held) but not yet charged, that hold will be automatically released when the order is cancelled, even if you choose not to refund other payments.

The mutation supports different cancellation reasons: customer requests, payment declines, fraud, inventory issues, staff errors, or other unspecified reasons. Each cancellation can include optional staff notes for internal documentation (notes aren't visible to customers).

An order can only be cancelled if it meets the following criteria:

• The order hasn't already been cancelled.
• The order has no pending payment authorizations.
• The order has no active returns in progress.
• The order has no outstanding fulfillments that can't be cancelled.

Orders might be assigned to locations that become deactivated after the order was created. When cancelling such orders, inventory behavior depends on payment status:

• Paid orders: Cancellation will fail with an error if restocking is enabled, since inventory can't be returned to deactivated locations.
• Unpaid orders: Cancellation succeeds but inventory is not restocked anywhere, even when the restock option is enabled. The committed inventory effectively becomes unavailable rather than being returned to stock at the deactivated location.

After you cancel an order, you can still make limited updates to certain fields (like notes and tags) using the orderUpdate.

For partial refunds or more complex refund scenarios on active orders, such as refunding only specific line items while keeping the rest of the order fulfilled, consider using the refundCreate mutation instead of full order cancellation.

Learn how to build apps that integrate with order management and fulfillment processes.

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: 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.

Asynchronously reorders the media attached to a product, changing the sequence in which images, videos, and other media appear in product displays. This affects how media is presented across all sales channels.

For example, merchants can move their best product photo to the first position or reorder images to tell a better product story, with changes appearing in storefronts once processing completes.

Use ProductReorderMedia to:

• Optimize media presentation order for better customer experience
• Implement drag-and-drop media management interfaces
• Automate media sequencing based on performance or quality metrics

The operation processes asynchronously to handle products with large media collections without blocking other operations.

Learn more about product media.

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.

Create or update theme files.

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.

Submits a UrlRedirectImport request to be processed.

The UrlRedirectImport request is first created with the urlRedirectImportCreate mutation.