API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

collectionRemoveProducts mutation

Version unstable

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

Argument Description
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 2021-04 (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

Argument Description
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 2021-01 (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

Argument Description
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 2020-10

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

Argument Description
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 2020-07

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

Argument Description
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 2020-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

Argument Description
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 2020-01 (Unsupported)

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

Argument Description
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 (Unsupported)

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

Argument Description
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 (Unsupported)

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

Argument Description
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-04 (Unsupported)

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

Argument Description
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.