Anchor to section titled 'undefined'product
product
mutation
deprecated
2024-04
Requires write access scope. Also: The user must have a permission to reorder product images.
Asynchronously reorders a set of images for a given product. Use product instead.
Anchor to section titled 'Arguments'
Arguments
The ID of the product on which to reorder images.
A list of moves to perform which will be evaluated in order.
Was this section helpful?
Anchor to section titled 'ProductReorderImagesPayload returns'
ProductReorderImagesPayload returns
The asynchronous job which reorders the images.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productReorderImages
Query Reference for MUTATION: productReorderImages
"mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n productReorderImages(id: $id, moves: $moves) {\n job {\n # Job fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productReorderImages
"{\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: productReorderImages
"input MoveInput {\n id: ID!\n newPosition: UnsignedInt64!\n}\n"Display Examples for MUTATION: productReorderImages
[
{
"example": {
"type_name": "productreorderimages",
"title": "Reorder a product's images",
"description": "Update the order of a product's images",
"query_string": "mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n productReorderImages(id: $id, moves: $moves) {\n job {\n id\n }\n }\n}",
"variables": {
"id": "gid://shopify/Product/108828309",
"moves": [
{
"id": "gid://shopify/ProductImage/183532652",
"newPosition": "2"
},
{
"id": "gid://shopify/ProductImage/731367280",
"newPosition": "3"
}
]
},
"response": {
"data": {
"productReorderImages": {
"job": {
"id": "gid://shopify/Job/9b108d8e-4317-40a9-9570-17682a8891d5"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "2024-07",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_reorder_images_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) { productReorderImages(id: $id, moves: $moves) { job { id } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"moves\": [\n {\n \"id\": \"gid://shopify/ProductImage/183532652\",\n \"newPosition\": \"2\"\n },\n {\n \"id\": \"gid://shopify/ProductImage/731367280\",\n \"newPosition\": \"3\"\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n productReorderImages(id: $id, moves: $moves) {\n job {\n id\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Product/108828309\",\n \"moves\": [\n {\n \"id\": \"gid://shopify/ProductImage/183532652\",\n \"newPosition\": \"2\"\n },\n {\n \"id\": \"gid://shopify/ProductImage/731367280\",\n \"newPosition\": \"3\"\n }\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 productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n productReorderImages(id: $id, moves: $moves) {\n job {\n id\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Product/108828309\",\n \"moves\": [{\"id\"=>\"gid://shopify/ProductImage/183532652\", \"newPosition\"=>\"2\"}, {\"id\"=>\"gid://shopify/ProductImage/731367280\", \"newPosition\"=>\"3\"}]\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 productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n productReorderImages(id: $id, moves: $moves) {\n job {\n id\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"moves\": [\n {\n \"id\": \"gid://shopify/ProductImage/183532652\",\n \"newPosition\": \"2\"\n },\n {\n \"id\": \"gid://shopify/ProductImage/731367280\",\n \"newPosition\": \"3\"\n }\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 productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n productReorderImages(id: $id, moves: $moves) {\n job {\n id\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Product/108828309\",\n \"moves\" => [{\"id\"=>\"gid://shopify/ProductImage/183532652\", \"newPosition\"=>\"2\"}, {\"id\"=>\"gid://shopify/ProductImage/731367280\", \"newPosition\"=>\"3\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the product on which to reorder images.",
"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/Product/108828309\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "moves",
"description": "A list of moves to perform which will be evaluated in order.",
"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/ProductImage/183532652\",\"newPosition\":\"2\"},{\"id\":\"gid://shopify/ProductImage/731367280\",\"newPosition\":\"3\"}]",
"typeKind": "MUTATION"
}
]
}
]