productVariantsBulkReorder

mutation

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

Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

Arguments

Anchor to positionspositions • [ProductVariantPositionInput!]!required: An array of variant positions.
Anchor to productIdproductId • ID!required: The product ID of the variants to be reordered.

Was this section helpful?

Anchor to ProductVariantsBulkReorderPayload returnsProductVariantsBulkReorderPayload returns

Anchor to productproduct • Product: The updated product.
Anchor to userErrorsuserErrors • [ProductVariantsBulkReorderUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation productVariantsBulkReorder($positions: [ProductVariantPositionInput!]!, $productId: ID!) {
2  productVariantsBulkReorder(positions: $positions, productId: $productId) {
3    product {
4      # Product fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "positions": [
3    {
4      "id": "gid://shopify/<objectName>/10079785100",
5      "position": 1
6    }
7  ],
8  "productId": "gid://shopify/<objectName>/10079785100"
9}

{
  "positions": [
    {
      "id": "gid://shopify/<objectName>/10079785100",
      "position": 1
    }
  ],
  "productId": "gid://shopify/<objectName>/10079785100"
}

input ProductVariantPositionInput {
  id: ID!
  position: Int!
}