collectionRemoveProducts mutation
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |
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.
On this page
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. |