Choose a version:

collectionAddProductsV2

mutation

Requires write_products access scope. Also: The user must have a permission to add products to a collection.

Adds products to a Collection asynchronously and returns a Job to track the operation's progress. This mutation handles large product sets efficiently by processing them in the background.

You can poll the returned job using the job query to monitor completion status.

Note

This mutation adds products in the order specified in the productIds argument.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the collection that's being updated.
Anchor to productIdsproductIds •[ID!]! required: The IDs of the products that are being added to the collection. If the collection's sort order is manual, the products will be added in the order in which they are provided.

Was this section helpful?

Anchor to CollectionAddProductsV2Payload returnsCollectionAddProductsV2Payload returns

Anchor to jobjob •Job: The asynchronous job adding the products.
Anchor to userErrorsuserErrors •[CollectionAddProductsV2UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

collectionAddProductsV2 reference

Mutation Reference

mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {

collectionAddProductsV2(id: $id, productIds: $productIds) {

job {

# Job fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"productIds": [

"gid://shopify/<objectName>/10079785100"

]

}