collectionReorderProducts - admin-graphql - MUTATION

Version: unstable

Description:

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](https://shopify.dev/api/admin-graphql/latest/queries/job). The [`Collection.sortOrder`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be `MANUAL`. Displaced products will have their position altered in a consistent manner, with no gaps.

Access Scopes

`write_products` access scope. Also: The user must have a permission to reorder products within a collection.

Arguments

• id: ID! - The ID of the collection on which to reorder products.
• moves: MoveInput! - 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.

Returns

• job: Job The asynchronous job reordering the products.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Move a product to the top of a collection

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"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"
          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"
          Graphql 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}"
        

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

  Move a product to the top of a sorted collection

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"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"
          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"
          Graphql 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}"
        

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