collectionAddProducts mutation

Version 2020-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 2019-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 2019-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 2019-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.

Sign up for a Partner account to get started.

Sign up