Anchor to section titled 'undefined'

productOptionsReorder
mutation

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

Reorders options and option values on a product, causing product variants to alter their position.

Options order take precedence over option values order. Depending on the existing product variants, some input orders might not be achieved.

Example: Existing product variants: ["Red / Small", "Green / Medium", "Blue / Small"].

New order: [ { name: "Size", values: [{ name: "Small" }, { name: "Medium" }], name: "Color", values: [{ name: "Green" }, { name: "Red" }, { name: "Blue" }] } ].

Description: Variants with "Green" value are expected to appear before variants with "Red" and "Blue" values. However, "Size" option appears before "Color".

Therefore, output will be: ["Small / "Red", "Small / Blue", "Medium / Green"].


Options to reorder on the product.

Anchor to productId
productId
required

The ID of the product to update.


Was this section helpful?

The updated product object.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation reorderOptions($options: [OptionReorderInput!]!, $productId: ID!) {
  productOptionsReorder(options: $options, productId: $productId) {
    userErrors {
      field
      message
      code
    }
    product {
      id
      options {
        id
        name
        values
        position
        optionValues {
          id
          name
          hasVariants
        }
      }
      variants(first: 5) {
        nodes {
          id
          title
          selectedOptions {
            name
            value
          }
        }
      }
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation reorderOptions($options: [OptionReorderInput!]!, $productId: ID!) { productOptionsReorder(options: $options, productId: $productId) { userErrors { field message code } product { id options { id name values position optionValues { id name hasVariants } } variants(first: 5) { nodes { id title selectedOptions { name value } } } } } }",
 "variables": {
    "productId": "gid://shopify/Product/1072481054",
    "options": [
      {
        "name": "Color",
        "values": [
          {
            "name": "Green"
          },
          {
            "name": "Blue"
          },
          {
            "name": "Red"
          }
        ]
      },
      {
        "name": "Size"
      }
    ]
  }
}'
const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation reorderOptions($options: [OptionReorderInput!]!, $productId: ID!) {
    productOptionsReorder(options: $options, productId: $productId) {
      userErrors {
        field
        message
        code
      }
      product {
        id
        options {
          id
          name
          values
          position
          optionValues {
            id
            name
            hasVariants
          }
        }
        variants(first: 5) {
          nodes {
            id
            title
            selectedOptions {
              name
              value
            }
          }
        }
      }
    }
  }`,
  {
    variables: {
      "productId": "gid://shopify/Product/1072481054",
      "options": [
        {
          "name": "Color",
          "values": [
            {
              "name": "Green"
            },
            {
              "name": "Blue"
            },
            {
              "name": "Red"
            }
          ]
        },
        {
          "name": "Size"
        }
      ]
    },
  },
);

const data = await response.json();
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 reorderOptions($options: [OptionReorderInput!]!, $productId: ID!) {
    productOptionsReorder(options: $options, productId: $productId) {
      userErrors {
        field
        message
        code
      }
      product {
        id
        options {
          id
          name
          values
          position
          optionValues {
            id
            name
            hasVariants
          }
        }
        variants(first: 5) {
          nodes {
            id
            title
            selectedOptions {
              name
              value
            }
          }
        }
      }
    }
  }
QUERY

variables = {
  "productId": "gid://shopify/Product/1072481054",
  "options": [{"name"=>"Color", "values"=>[{"name"=>"Green"}, {"name"=>"Blue"}, {"name"=>"Red"}]}, {"name"=>"Size"}]
}

response = client.query(query: query, variables: variables)
const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation reorderOptions($options: [OptionReorderInput!]!, $productId: ID!) {
      productOptionsReorder(options: $options, productId: $productId) {
        userErrors {
          field
          message
          code
        }
        product {
          id
          options {
            id
            name
            values
            position
            optionValues {
              id
              name
              hasVariants
            }
          }
          variants(first: 5) {
            nodes {
              id
              title
              selectedOptions {
                name
                value
              }
            }
          }
        }
      }
    }`,
    "variables": {
      "productId": "gid://shopify/Product/1072481054",
      "options": [
        {
          "name": "Color",
          "values": [
            {
              "name": "Green"
            },
            {
              "name": "Blue"
            },
            {
              "name": "Red"
            }
          ]
        },
        {
          "name": "Size"
        }
      ]
    },
  },
});
use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation reorderOptions($options: [OptionReorderInput!]!, $productId: ID!) {
    productOptionsReorder(options: $options, productId: $productId) {
      userErrors {
        field
        message
        code
      }
      product {
        id
        options {
          id
          name
          values
          position
          optionValues {
            id
            name
            hasVariants
          }
        }
        variants(first: 5) {
          nodes {
            id
            title
            selectedOptions {
              name
              value
            }
          }
        }
      }
    }
  }
QUERY;

$variables = [
  "productId" => "gid://shopify/Product/1072481054",
  "options" => [{"name"=>"Color", "values"=>[{"name"=>"Green"}, {"name"=>"Blue"}, {"name"=>"Red"}]}, {"name"=>"Size"}],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "productId": "gid://shopify/Product/1072481054",
  "options": [
    {
      "name": "Color",
      "values": [
        {
          "name": "Green"
        },
        {
          "name": "Blue"
        },
        {
          "name": "Red"
        }
      ]
    },
    {
      "name": "Size"
    }
  ]
}
Hide code
Response
JSON
{
  "productOptionsReorder": {
    "userErrors": [],
    "product": {
      "id": "gid://shopify/Product/1072481054",
      "options": [
        {
          "id": "gid://shopify/ProductOption/1064576509",
          "name": "Color",
          "values": [
            "Green",
            "Blue",
            "Red"
          ],
          "position": 1,
          "optionValues": [
            {
              "name": "Green",
              "hasVariants": true
            },
            {
              "name": "Blue",
              "hasVariants": true
            },
            {
              "name": "Red",
              "hasVariants": true
            }
          ]
        },
        {
          "id": "gid://shopify/ProductOption/1064576508",
          "name": "Size",
          "values": [
            "L",
            "S",
            "M"
          ],
          "position": 2,
          "optionValues": [
            {
              "name": "L",
              "hasVariants": true
            },
            {
              "name": "S",
              "hasVariants": true
            },
            {
              "name": "M",
              "hasVariants": true
            }
          ]
        }
      ],
      "variants": {
        "nodes": [
          {
            "id": "gid://shopify/ProductVariant/1070325063",
            "title": "Green / L",
            "selectedOptions": [
              {
                "name": "Color",
                "value": "Green"
              },
              {
                "name": "Size",
                "value": "L"
              }
            ]
          },
          {
            "id": "gid://shopify/ProductVariant/1070325061",
            "title": "Blue / S",
            "selectedOptions": [
              {
                "name": "Color",
                "value": "Blue"
              },
              {
                "name": "Size",
                "value": "S"
              }
            ]
          },
          {
            "id": "gid://shopify/ProductVariant/1070325062",
            "title": "Red / M",
            "selectedOptions": [
              {
                "name": "Color",
                "value": "Red"
              },
              {
                "name": "Size",
                "value": "M"
              }
            ]
          }
        ]
      }
    }
  }
}