Anchor to section titled 'undefined'collection
collection
mutation
2024-10latest
Requires write access scope. Also: The user must have a permission to add products to a collection.
Asynchronously adds a set of products to a given collection. It can take a long time to run. Instead of returning a collection, it returns a job which should be polled.
Anchor to section titled 'Arguments'
Arguments
The ID of the collection that's being updated.
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 section titled 'CollectionAddProductsV2Payload returns'
CollectionAddProductsV2Payload returns
The asynchronous job adding the products.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: collectionAddProductsV2
Query Reference for MUTATION: collectionAddProductsV2
"mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n # Job fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: collectionAddProductsV2
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"productIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n}"Schema Reference for MUTATION: collectionAddProductsV2
""
Display Examples for MUTATION: collectionAddProductsV2
[
{
"example": {
"type_name": "collectionaddproductsv2",
"title": "Add a product to a non-existing collection",
"description": "If the input collection doesn't exist, then the mutation returns an error.\n",
"query_string": "mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/-1",
"productIds": [
"gid://shopify/Product/108828309"
]
},
"response": {
"data": {
"collectionAddProductsV2": {
"job": null,
"userErrors": [
{
"field": [
"id"
],
"message": "Collection does not exist"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/collection_add_products_v2_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) { collectionAddProductsV2(id: $id, productIds: $productIds) { job { done id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/-1\",\n \"productIds\": [\n \"gid://shopify/Product/108828309\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/-1\",\n \"productIds\": [\n \"gid://shopify/Product/108828309\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/-1\",\n \"productIds\": [\"gid://shopify/Product/108828309\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/-1\",\n \"productIds\": [\n \"gid://shopify/Product/108828309\"\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/-1\",\n \"productIds\" => [\"gid://shopify/Product/108828309\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection that's being updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Collection/-1\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "productIds",
"description": "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.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productIds",
"argValue": " [\"gid://shopify/Product/108828309\"]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "collectionaddproductsv2",
"title": "Add a product to a smart collection",
"description": "Products can't be manually added to a smart collection, so the mutation returns an error.\n",
"query_string": "mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/142458073",
"productIds": [
"gid://shopify/Product/910489600"
]
},
"response": {
"data": {
"collectionAddProductsV2": {
"job": null,
"userErrors": [
{
"field": [
"id"
],
"message": "Can't manually add products to a smart collection"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/collection_add_products_v2_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) { collectionAddProductsV2(id: $id, productIds: $productIds) { job { done id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/142458073\",\n \"productIds\": [\n \"gid://shopify/Product/910489600\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/142458073\",\n \"productIds\": [\n \"gid://shopify/Product/910489600\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/142458073\",\n \"productIds\": [\"gid://shopify/Product/910489600\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/142458073\",\n \"productIds\": [\n \"gid://shopify/Product/910489600\"\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/142458073\",\n \"productIds\" => [\"gid://shopify/Product/910489600\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection that's being updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Collection/142458073\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "productIds",
"description": "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.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productIds",
"argValue": " [\"gid://shopify/Product/910489600\"]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "collectionaddproductsv2",
"title": "Add products that already belong to the specified collection",
"description": "Products that already belong to the collection are ignored, and the eligible products are added.\n",
"query_string": "mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/1007901140",
"productIds": [
"gid://shopify/Product/108828309",
"gid://shopify/Product/632910392",
"gid://shopify/Product/20995642"
]
},
"response": {
"data": {
"collectionAddProductsV2": {
"job": {
"done": false,
"id": "gid://shopify/Job/f2d9094c-e3d7-45b0-9eaa-b58976f7af3e"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/collection_add_products_v2_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) { collectionAddProductsV2(id: $id, productIds: $productIds) { job { done id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/1007901140\",\n \"productIds\": [\n \"gid://shopify/Product/108828309\",\n \"gid://shopify/Product/632910392\",\n \"gid://shopify/Product/20995642\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/1007901140\",\n \"productIds\": [\n \"gid://shopify/Product/108828309\",\n \"gid://shopify/Product/632910392\",\n \"gid://shopify/Product/20995642\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/1007901140\",\n \"productIds\": [\"gid://shopify/Product/108828309\", \"gid://shopify/Product/632910392\", \"gid://shopify/Product/20995642\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/1007901140\",\n \"productIds\": [\n \"gid://shopify/Product/108828309\",\n \"gid://shopify/Product/632910392\",\n \"gid://shopify/Product/20995642\"\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/1007901140\",\n \"productIds\" => [\"gid://shopify/Product/108828309\", \"gid://shopify/Product/632910392\", \"gid://shopify/Product/20995642\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection that's being updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Collection/1007901140\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "productIds",
"description": "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.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productIds",
"argValue": " [\"gid://shopify/Product/108828309\",\"gid://shopify/Product/632910392\",\"gid://shopify/Product/20995642\"]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "collectionaddproductsv2",
"title": "Add products that don't exist to an existing collection",
"description": "Products that don't exist are ignored, and the eligible products are added.\n",
"query_string": "mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/636030761",
"productIds": [
"gid://shopify/Product/-1",
"gid://shopify/Product/108828309",
"gid://shopify/Product/-2"
]
},
"response": {
"data": {
"collectionAddProductsV2": {
"job": {
"done": false,
"id": "gid://shopify/Job/fdabe76d-6ba6-4404-90c0-f7ad8dfef0c7"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/collection_add_products_v2_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) { collectionAddProductsV2(id: $id, productIds: $productIds) { job { done id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\n \"gid://shopify/Product/-1\",\n \"gid://shopify/Product/108828309\",\n \"gid://shopify/Product/-2\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\n \"gid://shopify/Product/-1\",\n \"gid://shopify/Product/108828309\",\n \"gid://shopify/Product/-2\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\"gid://shopify/Product/-1\", \"gid://shopify/Product/108828309\", \"gid://shopify/Product/-2\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\n \"gid://shopify/Product/-1\",\n \"gid://shopify/Product/108828309\",\n \"gid://shopify/Product/-2\"\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/636030761\",\n \"productIds\" => [\"gid://shopify/Product/-1\", \"gid://shopify/Product/108828309\", \"gid://shopify/Product/-2\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection that's being updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Collection/636030761\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "productIds",
"description": "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.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productIds",
"argValue": " [\"gid://shopify/Product/-1\",\"gid://shopify/Product/108828309\",\"gid://shopify/Product/-2\"]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "collectionaddproductsv2",
"title": "Add products to an existing collection",
"description": "Add 2 products with specified IDs to the collection.\n",
"query_string": "mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/636030761",
"productIds": [
"gid://shopify/Product/121709582",
"gid://shopify/Product/108828309"
]
},
"response": {
"data": {
"collectionAddProductsV2": {
"job": {
"done": false,
"id": "gid://shopify/Job/623cf371-2e67-4d4f-9bd1-dbfdd7b8a58b"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/collection_add_products_v2_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) { collectionAddProductsV2(id: $id, productIds: $productIds) { job { done id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\n \"gid://shopify/Product/121709582\",\n \"gid://shopify/Product/108828309\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\n \"gid://shopify/Product/121709582\",\n \"gid://shopify/Product/108828309\"\n ]\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\"gid://shopify/Product/121709582\", \"gid://shopify/Product/108828309\"]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/636030761\",\n \"productIds\": [\n \"gid://shopify/Product/121709582\",\n \"gid://shopify/Product/108828309\"\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation collectionAddProductsV2($id: ID!, $productIds: [ID!]!) {\n collectionAddProductsV2(id: $id, productIds: $productIds) {\n job {\n done\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/636030761\",\n \"productIds\" => [\"gid://shopify/Product/121709582\", \"gid://shopify/Product/108828309\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection that's being updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Collection/636030761\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "productIds",
"description": "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.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productIds",
"argValue": " [\"gid://shopify/Product/121709582\",\"gid://shopify/Product/108828309\"]",
"typeKind": "MUTATION"
}
]
}
]