productOptionsCreate

mutation

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

Creates options on a product.

Arguments

Anchor to optionsoptions • [OptionCreateInput!]!required: Options to add to the product.
Anchor to productIdproductId • ID!required: The ID of the product to update.
Anchor to variantStrategyvariantStrategy • ProductOptionCreateVariantStrategyDefault:LEAVE_AS_IS: The strategy defines which behavior the mutation should observe regarding variants. If not provided or set to null, the strategy LEAVE_AS_IS will be used.

Was this section helpful?

Anchor to ProductOptionsCreatePayload returnsProductOptionsCreatePayload returns

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

Was this section helpful?

Create a product option linked to a metafield
Create a product option linked to a metafield (with existing values)
Create new product option and variants with CREATE variantStrategy
Create new product option but no new variants with LEAVE_AS_IS variantStrategy
Create new product option with an explicit position
Create new product options
Trying to create an option with a name that already exists on the product returns an error
Trying to create too many options returns an error
productOptionsCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {
6    productOptionsCreate(productId: $productId, options: $options) {
7      userErrors {
8        field
9        message
10        code
11      }
12      product {
13        options {
14          name
15          linkedMetafield {
16            namespace
17            key
18          }
19          optionValues {
20            name
21            linkedMetafieldValue
22          }
23        }
24      }
25    }
26  }`,
27  {
28    variables: {
29      "productId": "gid://shopify/Product/1072481128",
30      "options": [
31        {
32          "name": "Color",
33          "linkedMetafield": {
34            "namespace": "shopify",
35            "key": "color-pattern",
36            "values": [
37              "gid://shopify/Metaobject/971662503",
38              "gid://shopify/Metaobject/971662504",
39              "gid://shopify/Metaobject/971662505"
40            ]
41          }
42        }
43      ]
44    },
45  },
46);
47
48const data = await response.json();
49

mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {
  productOptionsCreate(productId: $productId, options: $options) {
    userErrors {
      field
      message
      code
    }
    product {
      options {
        name
        linkedMetafield {
          namespace
          key
        }
        optionValues {
          name
          linkedMetafieldValue
        }
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) { productOptionsCreate(productId: $productId, options: $options) { userErrors { field message code } product { options { name linkedMetafield { namespace key } optionValues { name linkedMetafieldValue } } } } }",
 "variables": {
    "productId": "gid://shopify/Product/1072481128",
    "options": [
      {
        "name": "Color",
        "linkedMetafield": {
          "namespace": "shopify",
          "key": "color-pattern",
          "values": [
            "gid://shopify/Metaobject/971662503",
            "gid://shopify/Metaobject/971662504",
            "gid://shopify/Metaobject/971662505"
          ]
        }
      }
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {
    productOptionsCreate(productId: $productId, options: $options) {
      userErrors {
        field
        message
        code
      }
      product {
        options {
          name
          linkedMetafield {
            namespace
            key
          }
          optionValues {
            name
            linkedMetafieldValue
          }
        }
      }
    }
  }`,
  {
    variables: {
      "productId": "gid://shopify/Product/1072481128",
      "options": [
        {
          "name": "Color",
          "linkedMetafield": {
            "namespace": "shopify",
            "key": "color-pattern",
            "values": [
              "gid://shopify/Metaobject/971662503",
              "gid://shopify/Metaobject/971662504",
              "gid://shopify/Metaobject/971662505"
            ]
          }
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {
      productOptionsCreate(productId: $productId, options: $options) {
        userErrors {
          field
          message
          code
        }
        product {
          options {
            name
            linkedMetafield {
              namespace
              key
            }
            optionValues {
              name
              linkedMetafieldValue
            }
          }
        }
      }
    }`,
    "variables": {
      "productId": "gid://shopify/Product/1072481128",
      "options": [
        {
          "name": "Color",
          "linkedMetafield": {
            "namespace": "shopify",
            "key": "color-pattern",
            "values": [
              "gid://shopify/Metaobject/971662503",
              "gid://shopify/Metaobject/971662504",
              "gid://shopify/Metaobject/971662505"
            ]
          }
        }
      ]
    },
  },
});

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 createOptions($productId: ID!, $options: [OptionCreateInput!]!) {
    productOptionsCreate(productId: $productId, options: $options) {
      userErrors {
        field
        message
        code
      }
      product {
        options {
          name
          linkedMetafield {
            namespace
            key
          }
          optionValues {
            name
            linkedMetafieldValue
          }
        }
      }
    }
  }
QUERY

variables = {
  "productId": "gid://shopify/Product/1072481128",
  "options": [{"name"=>"Color", "linkedMetafield"=>{"namespace"=>"shopify", "key"=>"color-pattern", "values"=>["gid://shopify/Metaobject/971662503", "gid://shopify/Metaobject/971662504", "gid://shopify/Metaobject/971662505"]}}]
}

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

Input variables

JSON

1{
2  "productId": "gid://shopify/Product/1072481128",
3  "options": [
4    {
5      "name": "Color",
6      "linkedMetafield": {
7        "namespace": "shopify",
8        "key": "color-pattern",
9        "values": [
10          "gid://shopify/Metaobject/971662503",
11          "gid://shopify/Metaobject/971662504",
12          "gid://shopify/Metaobject/971662505"
13        ]
14      }
15    }
16  ]
17}

Response

JSON

1{
2  "productOptionsCreate": {
3    "userErrors": [],
4    "product": {
5      "options": [
6        {
7          "name": "Color",
8          "linkedMetafield": {
9            "namespace": "shopify",
10            "key": "color-pattern"
11          },
12          "optionValues": [
13            {
14              "name": "Red",
15              "linkedMetafieldValue": "gid://shopify/Metaobject/971662503"
16            },
17            {
18              "name": "Blue",
19              "linkedMetafieldValue": "gid://shopify/Metaobject/971662504"
20            },
21            {
22              "name": "Yellow",
23              "linkedMetafieldValue": "gid://shopify/Metaobject/971662505"
24            }
25          ]
26        }
27      ]
28    }
29  }
30}