We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

collectionRemoveProducts

Version 2019-04

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

The ID of the collection to remove products from.

productIds ( [ID!]! ) required

The IDs of products to remove from the collection.

Return Fields

job (Job)

The asynchronous job removing the products.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Latest)

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

The ID of the collection to remove products from.

productIds ( [ID!]! ) required

The IDs of products to remove from the collection.

Return Fields

job (Job)

The asynchronous job removing the products.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Release candidate)

Removes a set of products from a given collection. It can take a long time to run. Instead of returning a collection it returns a job, which should be polled.

Required access

write_products access scope

Interactive Example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

The ID of the collection to remove products from.

productIds ( [ID!]! ) required

The IDs of products to remove from the collection.

Return Fields

job (Job)

The asynchronous job removing the products.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up