Anchor to section titled 'undefined'collection
collection
mutation
2024-07
Requires write access scope. Also: The user must have a permission to reorder products within a collection.
Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The Collection.sort must be M. Displaced products will have their position altered in a consistent manner, with no gaps.
Anchor to section titled 'Arguments'
Arguments
The ID of the collection on which to reorder products.
A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the
newdoes not have to be unique.Position
Was this section helpful?
Anchor to section titled 'CollectionReorderProductsPayload returns'
CollectionReorderProductsPayload returns
The asynchronous job reordering the products.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: collectionReorderProducts
Query Reference for MUTATION: collectionReorderProducts
"mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n # Job fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: collectionReorderProducts
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"moves\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"newPosition\": \"50\"\n }\n ]\n}"Schema Reference for MUTATION: collectionReorderProducts
"input MoveInput {\n id: ID!\n newPosition: UnsignedInt64!\n}\n"Display Examples for MUTATION: collectionReorderProducts
[
{
"example": {
"type_name": "collectionreorderproducts",
"title": "Move a product to the top of a collection",
"description": "Moving a product to the top of a collection will return a job ID. All other product positions will be updated and incremented by 1 during processing.",
"query_string": "mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/79210309",
"moves": {
"id": "gid://shopify/Product/20995642",
"newPosition": "0"
}
},
"response": {
"data": {
"collectionReorderProducts": {
"job": {
"id": "gid://shopify/Job/fe401699-4382-4a0f-b32f-28a35b06d524"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/collection_reorder_products_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) { collectionReorderProducts(id: $id, moves: $moves) { job { id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/79210309\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/20995642\",\n \"newPosition\": \"0\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/79210309\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/20995642\",\n \"newPosition\": \"0\"\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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/79210309\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/20995642\",\n \"newPosition\": \"0\"\n }\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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/79210309\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/20995642\",\n \"newPosition\": \"0\"\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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/79210309\",\n \"moves\" => [\n \"id\" => \"gid://shopify/Product/20995642\",\n \"newPosition\" => \"0\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection on which to reorder products.",
"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/79210309\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "moves",
"description": "A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the `newPosition` does not have to be unique.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoveInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[MoveInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "moves",
"argValue": " {\"id\":\"gid://shopify/Product/20995642\",\"newPosition\":\"0\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "collectionreorderproducts",
"title": "Move a product to the top of a sorted collection",
"description": "Attempting to move a product within a non-manually sorted collection will return a user error.",
"query_string": "mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Collection/1063001310",
"moves": {
"id": "gid://shopify/Product/108828309",
"newPosition": "0"
}
},
"response": {
"data": {
"collectionReorderProducts": {
"job": null,
"userErrors": [
{
"field": [
"id"
],
"message": "Can't reorder products unless collection is manually sorted"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/collection_reorder_products_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) { collectionReorderProducts(id: $id, moves: $moves) { job { id } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Collection/1063001310\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"newPosition\": \"0\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Collection/1063001310\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"newPosition\": \"0\"\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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Collection/1063001310\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"newPosition\": \"0\"\n }\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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Collection/1063001310\",\n \"moves\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"newPosition\": \"0\"\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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {\n collectionReorderProducts(id: $id, moves: $moves) {\n job {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Collection/1063001310\",\n \"moves\" => [\n \"id\" => \"gid://shopify/Product/108828309\",\n \"newPosition\" => \"0\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the collection on which to reorder products.",
"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/1063001310\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "moves",
"description": "A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the `newPosition` does not have to be unique.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoveInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[MoveInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "moves",
"argValue": " {\"id\":\"gid://shopify/Product/108828309\",\"newPosition\":\"0\"}",
"typeKind": "MUTATION"
}
]
}
]