Skip to main content
Anchor to CollectionRemoveProductsPayload

CollectionRemoveProductsPayload

payload

Return type for collectionRemoveProducts mutation.

•Job

The asynchronous job removing the products.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

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.


Was this section helpful?