Choose a version:

collectionReorderProducts

mutation

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

Asynchronously reorders products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The Collection.sortOrder must be MANUAL.

How to use this mutation:

Provide only the products that actually moved in the moves list; do not send the entire product list. For example: to move the product at index 1 to index N, send a single move for that product with newPosition: N.
Each move is applied sequentially in the order provided.
newPosition is a zero-based index within the collection at the moment the move is applied (after any prior moves in the list).
Products not included in moves keep their relative order, aside from any displacement caused by the moves.
If newPosition is greater than or equal to the number of products, the product is placed at the end.

Example:

Initial order: [A, B, C, D, E] (indices 0..4)
Moves (applied in order):
- E -> newPosition: 1
- C -> newPosition: 4
Result: [A, E, B, D, C]

Displaced products will have their position altered in a consistent manner with no gaps.

Arguments

Anchor to idid •ID! required: The ID of the collection on which to reorder products.
Anchor to movesmoves •[MoveInput!]! required: A list of moves to perform, evaluated in order. Provide only products whose positions changed; do not send the full list. newPosition is a zero-based index evaluated at the time each move is applied (after any prior moves). newPosition values do not need to be unique, and if a value is greater than or equal to the number of products, the product is moved to the end. Up to 250 moves are supported.

Was this section helpful?

Anchor to CollectionReorderProductsPayload returnsCollectionReorderProductsPayload returns

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

Was this section helpful?

Examples

Move a product to the top of a collection

Description

Moving a product to the top of a collection will return a job ID. All other product positions will be updated and incremented by 1 during processing.

Query

mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
  collectionReorderProducts(id: $id, moves: $moves) {
    job {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Collection/79210309",
  "moves": {
    "id": "gid://shopify/Product/20995642",
    "newPosition": "0"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) { collectionReorderProducts(id: $id, moves: $moves) { job { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Collection/79210309",
    "moves": {
      "id": "gid://shopify/Product/20995642",
      "newPosition": "0"
    }
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
    collectionReorderProducts(id: $id, moves: $moves) {
      job {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Collection/79210309",
        "moves": {
            "id": "gid://shopify/Product/20995642",
            "newPosition": "0"
        }
    },
  },
);

const data = await response.json();

Ruby

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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
    collectionReorderProducts(id: $id, moves: $moves) {
      job {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Collection/79210309",
  "moves": {
    "id": "gid://shopify/Product/20995642",
    "newPosition": "0"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
      collectionReorderProducts(id: $id, moves: $moves) {
        job {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Collection/79210309",
        "moves": {
            "id": "gid://shopify/Product/20995642",
            "newPosition": "0"
        }
    },
  },
});

Response

{
  "collectionReorderProducts": {
    "job": {
      "id": "gid://shopify/Job/af3cb206-d472-4a54-902b-f34df6af4eb5"
    },
    "userErrors": []
  }
}

Move a product to the top of a sorted collection

Description

Attempting to move a product within a non-manually sorted collection will return a user error.

Query

mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
  collectionReorderProducts(id: $id, moves: $moves) {
    job {
      id
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Collection/1063001310",
  "moves": {
    "id": "gid://shopify/Product/108828309",
    "newPosition": "0"
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) { collectionReorderProducts(id: $id, moves: $moves) { job { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Collection/1063001310",
    "moves": {
      "id": "gid://shopify/Product/108828309",
      "newPosition": "0"
    }
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
    collectionReorderProducts(id: $id, moves: $moves) {
      job {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Collection/1063001310",
        "moves": {
            "id": "gid://shopify/Product/108828309",
            "newPosition": "0"
        }
    },
  },
);

const data = await response.json();

Ruby

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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
    collectionReorderProducts(id: $id, moves: $moves) {
      job {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Collection/1063001310",
  "moves": {
    "id": "gid://shopify/Product/108828309",
    "newPosition": "0"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
      collectionReorderProducts(id: $id, moves: $moves) {
        job {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Collection/1063001310",
        "moves": {
            "id": "gid://shopify/Product/108828309",
            "newPosition": "0"
        }
    },
  },
});

Response

{
  "collectionReorderProducts": {
    "job": null,
    "userErrors": [
      {
        "field": [
          "id"
        ],
        "message": "Can't reorder products unless collection is manually sorted"
      }
    ]
  }
}

Updates the ordering type of products in a smart collection

Query

mutation UpdateCollectionSortOrder($id: ID!, $sortOrder: CollectionSortOrder!) {
  collectionUpdate(input: {id: $id, sortOrder: $sortOrder}) {
    collection {
      id
      sortOrder
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/Collection/1063001310",
  "sortOrder": "MANUAL"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation UpdateCollectionSortOrder($id: ID!, $sortOrder: CollectionSortOrder!) { collectionUpdate(input: {id: $id, sortOrder: $sortOrder}) { collection { id sortOrder } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Collection/1063001310",
    "sortOrder": "MANUAL"
  }
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  mutation UpdateCollectionSortOrder($id: ID!, $sortOrder: CollectionSortOrder!) {
    collectionUpdate(input: {id: $id, sortOrder: $sortOrder}) {
      collection {
        id
        sortOrder
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Collection/1063001310",
        "sortOrder": "MANUAL"
    },
  },
);

const data = await response.json();

Ruby

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 UpdateCollectionSortOrder($id: ID!, $sortOrder: CollectionSortOrder!) {
    collectionUpdate(input: {id: $id, sortOrder: $sortOrder}) {
      collection {
        id
        sortOrder
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Collection/1063001310",
  "sortOrder": "MANUAL"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation UpdateCollectionSortOrder($id: ID!, $sortOrder: CollectionSortOrder!) {
      collectionUpdate(input: {id: $id, sortOrder: $sortOrder}) {
        collection {
          id
          sortOrder
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Collection/1063001310",
        "sortOrder": "MANUAL"
    },
  },
});

Response

{
  "collectionUpdate": {
    "collection": {
      "id": "gid://shopify/Collection/1063001310",
      "sortOrder": "MANUAL"
    },
    "userErrors": []
  }
}

collectionReorderProducts reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {

collectionReorderProducts(id: $id, moves: $moves) {

job {

}

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/Collection/79210309",

"moves": {

"id": "gid://shopify/Product/20995642",

"newPosition": "0"

}

);

const data = await response.json();

mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
  collectionReorderProducts(id: $id, moves: $moves) {
    job {
      id
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) { collectionReorderProducts(id: $id, moves: $moves) { job { id } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/Collection/79210309",
    "moves": {
      "id": "gid://shopify/Product/20995642",
      "newPosition": "0"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
    collectionReorderProducts(id: $id, moves: $moves) {
      job {
        id
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Collection/79210309",
        "moves": {
            "id": "gid://shopify/Product/20995642",
            "newPosition": "0"
        }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
      collectionReorderProducts(id: $id, moves: $moves) {
        job {
          id
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/Collection/79210309",
        "moves": {
            "id": "gid://shopify/Product/20995642",
            "newPosition": "0"
        }
    },
  },
});

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 collectionReorderProducts($id: ID!, $moves: [MoveInput!]!) {
    collectionReorderProducts(id: $id, moves: $moves) {
      job {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Collection/79210309",
  "moves": {
    "id": "gid://shopify/Product/20995642",
    "newPosition": "0"
  }
}

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

Input variables

JSON

{

"id": "gid://shopify/Collection/79210309",

"moves": {

"id": "gid://shopify/Product/20995642",

"newPosition": "0"

}

Response

JSON

{

"collectionReorderProducts": {

"job": {

"id": "gid://shopify/Job/af3cb206-d472-4a54-902b-f34df6af4eb5"

"userErrors": []

}