productReorderImages - admin-graphql - MUTATION

Version: 2024-07

Description:

Asynchronously reorders a set of images for a given product.

Access Scopes

`write_products` access scope. Also: The user must have a permission to reorder product images.

Arguments

• id: ID! - The ID of the product on which to reorder images.
• moves: MoveInput! - A list of moves to perform which will be evaluated in order.

Returns

• job: Job The asynchronous job which reorders the images.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Reorder a product's images

          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 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"
          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"
          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"
          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"
          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"
          Graphql query: "mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {\n  productReorderImages(id: $id, moves: $moves) {\n    job {\n      id\n    }\n  }\n}"
        

  input: {
    "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"
        }
      }
    }
  }