Anchor to section titled 'undefined'product
product
mutation
2024-04
Requires write access scope. Also: The user must have a permission to reorder the media attached to a product.
Asynchronously reorders the media attached to a product.
Anchor to section titled 'Arguments'
Arguments
The ID of the product on which to reorder medias.
A list of moves to perform which will be evaluated in order.
Was this section helpful?
Anchor to section titled 'ProductReorderMediaPayload returns'
ProductReorderMediaPayload returns
The asynchronous job which reorders the media.
The list of errors that occurred from executing the mutation.
The list of errors that occurred from executing the mutation. Use
mediainstead.User Errors
Was this section helpful?
Code examples for MUTATION: productReorderMedia
Query Reference for MUTATION: productReorderMedia
"mutation productReorderMedia($id: ID!, $moves: [MoveInput!]!) {\n productReorderMedia(id: $id, moves: $moves) {\n job {\n # Job fields\n }\n mediaUserErrors {\n # MediaUserError fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productReorderMedia
"{\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: productReorderMedia
"input MoveInput {\n id: ID!\n newPosition: UnsignedInt64!\n}\n"Display Examples for MUTATION: productReorderMedia
[
{
"example": {
"type_name": "productreordermedia",
"title": "Reorder a product's media",
"description": "Update the order of a product's media",
"query_string": "mutation productReorderMedia($id: ID!, $moves: [MoveInput!]!) {\n productReorderMedia(id: $id, moves: $moves) {\n job {\n id\n }\n }\n}",
"variables": {
"id": "gid://shopify/Product/108828309",
"moves": [
{
"id": "gid://shopify/MediaImage/183532652",
"newPosition": "2"
},
{
"id": "gid://shopify/MediaImage/731367280",
"newPosition": "3"
}
]
},
"response": {
"data": {
"productReorderMedia": {
"job": {
"id": "gid://shopify/Job/6dfa599a-a426-4030-8f10-6564abc465f9"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_reorder_media_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 productReorderMedia($id: ID!, $moves: [MoveInput!]!) { productReorderMedia(id: $id, moves: $moves) { job { id } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Product/108828309\",\n \"moves\": [\n {\n \"id\": \"gid://shopify/MediaImage/183532652\",\n \"newPosition\": \"2\"\n },\n {\n \"id\": \"gid://shopify/MediaImage/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 productReorderMedia($id: ID!, $moves: [MoveInput!]!) {\n productReorderMedia(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/MediaImage/183532652\",\n \"newPosition\": \"2\"\n },\n {\n \"id\": \"gid://shopify/MediaImage/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 productReorderMedia($id: ID!, $moves: [MoveInput!]!) {\n productReorderMedia(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/MediaImage/183532652\", \"newPosition\"=>\"2\"}, {\"id\"=>\"gid://shopify/MediaImage/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 productReorderMedia($id: ID!, $moves: [MoveInput!]!) {\n productReorderMedia(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/MediaImage/183532652\",\n \"newPosition\": \"2\"\n },\n {\n \"id\": \"gid://shopify/MediaImage/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 productReorderMedia($id: ID!, $moves: [MoveInput!]!) {\n productReorderMedia(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/MediaImage/183532652\", \"newPosition\"=>\"2\"}, {\"id\"=>\"gid://shopify/MediaImage/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 medias.",
"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/MediaImage/183532652\",\"newPosition\":\"2\"},{\"id\":\"gid://shopify/MediaImage/731367280\",\"newPosition\":\"3\"}]",
"typeKind": "MUTATION"
}
]
}
]