productReorderImages

mutationDeprecated

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

Asynchronously reorders a set of images for a given product. Use productReorderMedia instead.

Arguments

Anchor to idid • ID!required: The ID of the product on which to reorder images.
Anchor to movesmoves • [MoveInput!]!required: A list of moves to perform which will be evaluated in order.

Was this section helpful?

Anchor to ProductReorderImagesPayload returnsProductReorderImagesPayload returns

Anchor to jobjob • Job: The asynchronous job which reorders the images.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Reorder a product's images
productReorderImages reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {
6    productReorderImages(id: $id, moves: $moves) {
7      job {
8        id
9      }
10    }
11  }`,
12  {
13    variables: {
14      "id": "gid://shopify/Product/108828309",
15      "moves": [
16        {
17          "id": "gid://shopify/ProductImage/183532652",
18          "newPosition": "2"
19        },
20        {
21          "id": "gid://shopify/ProductImage/731367280",
22          "newPosition": "3"
23        }
24      ]
25    },
26  },
27);
28
29const data = await response.json();
30

mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {
  productReorderImages(id: $id, moves: $moves) {
    job {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) { productReorderImages(id: $id, moves: $moves) { job { id } } }",
 "variables": {
    "id": "gid://shopify/Product/108828309",
    "moves": [
      {
        "id": "gid://shopify/ProductImage/183532652",
        "newPosition": "2"
      },
      {
        "id": "gid://shopify/ProductImage/731367280",
        "newPosition": "3"
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {
    productReorderImages(id: $id, moves: $moves) {
      job {
        id
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Product/108828309",
      "moves": [
        {
          "id": "gid://shopify/ProductImage/183532652",
          "newPosition": "2"
        },
        {
          "id": "gid://shopify/ProductImage/731367280",
          "newPosition": "3"
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {
      productReorderImages(id: $id, moves: $moves) {
        job {
          id
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Product/108828309",
      "moves": [
        {
          "id": "gid://shopify/ProductImage/183532652",
          "newPosition": "2"
        },
        {
          "id": "gid://shopify/ProductImage/731367280",
          "newPosition": "3"
        }
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation productReorderImages($id: ID!, $moves: [MoveInput!]!) {
    productReorderImages(id: $id, moves: $moves) {
      job {
        id
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Product/108828309",
  "moves": [{"id"=>"gid://shopify/ProductImage/183532652", "newPosition"=>"2"}, {"id"=>"gid://shopify/ProductImage/731367280", "newPosition"=>"3"}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/Product/108828309",
3  "moves": [
4    {
5      "id": "gid://shopify/ProductImage/183532652",
6      "newPosition": "2"
7    },
8    {
9      "id": "gid://shopify/ProductImage/731367280",
10      "newPosition": "3"
11    }
12  ]
13}

Response

JSON

1{
2  "productReorderImages": {
3    "job": {
4      "id": "gid://shopify/Job/9b108d8e-4317-40a9-9570-17682a8891d5"
5    }
6  }
7}