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

collectionAddProducts mutation

Version unstable

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Adds products to a collection.

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 that's being updated.

productIds ( [ID!]! ) required

The IDs of the products that are being added to the collection.

Return fields

collection (Collection)

The updated collection.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.