Anchor to section titled 'undefined'product
product
mutation
2024-07
Requires write access scope. Also: The user must have a permission to create product variants.
Creates options on a product.
Anchor to section titled 'Arguments'
Arguments
Options to add to the product.
The ID of the product to update.
Was this section helpful?
Anchor to section titled 'ProductOptionsCreatePayload returns'
ProductOptionsCreatePayload returns
The updated product object.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productOptionsCreate
Query Reference for MUTATION: productOptionsCreate
"mutation productOptionsCreate($options: [OptionCreateInput!]!, $productId: ID!) {\n productOptionsCreate(options: $options, productId: $productId) {\n product {\n # Product fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productOptionsCreate
"{\n \"options\": [\n {\n \"linkedMetafield\": {\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"values\": [\n \"<your-values>\"\n ]\n },\n \"name\": \"<your-name>\",\n \"position\": 1,\n \"values\": [\n {\n \"linkedMetafieldValue\": \"<your-linkedMetafieldValue>\",\n \"name\": \"<your-name>\"\n }\n ]\n }\n ],\n \"productId\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: productOptionsCreate
"input OptionCreateInput {\n linkedMetafield: LinkedMetafieldCreateInput\n name: String\n position: Int\n values: [OptionValueCreateInput!]\n}\n\ninput LinkedMetafieldCreateInput {\n key: String!\n namespace: String!\n values: [String!]\n}\n\ninput OptionValueCreateInput {\n linkedMetafieldValue: String\n name: String\n}\n"Display Examples for MUTATION: productOptionsCreate
[
{
"example": {
"type_name": "productoptionscreate",
"title": "Create a product option linked to a metafield",
"description": "Use the `linkedMetafield` input to create options based on metafields and metaobjects.\nOptions can only be linked to [category metafields](https://help.shopify.com/manual/products/details/product-category#category-metafields).\nUse `linkedMetafield.values` to set the desired option values.\n\nMetafield-linked product options are only available in Shopify taxonomy early access.\n\n[Learn more about metafield-linked product options](https://shopify.dev/api/admin/migrate/new-product-model/metafield-linked).\n",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481047",
"options": [
{
"name": "Color",
"linkedMetafield": {
"namespace": "shopify",
"key": "color-pattern",
"values": [
"gid://shopify/Metaobject/971662467",
"gid://shopify/Metaobject/971662468",
"gid://shopify/Metaobject/971662469"
]
}
}
]
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [],
"product": {
"options": [
{
"name": "Color",
"linkedMetafield": {
"namespace": "shopify",
"key": "color-pattern"
},
"optionValues": [
{
"name": "Red",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662467"
},
{
"name": "Blue",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662468"
},
{
"name": "Yellow",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662469"
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481047\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"linkedMetafield\": {\n \"namespace\": \"shopify\",\n \"key\": \"color-pattern\",\n \"values\": [\n \"gid://shopify/Metaobject/971662467\",\n \"gid://shopify/Metaobject/971662468\",\n \"gid://shopify/Metaobject/971662469\"\n ]\n }\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481047\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"linkedMetafield\": {\n \"namespace\": \"shopify\",\n \"key\": \"color-pattern\",\n \"values\": [\n \"gid://shopify/Metaobject/971662467\",\n \"gid://shopify/Metaobject/971662468\",\n \"gid://shopify/Metaobject/971662469\"\n ]\n }\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481047\",\n \"options\": [{\"name\"=>\"Color\", \"linkedMetafield\"=>{\"namespace\"=>\"shopify\", \"key\"=>\"color-pattern\", \"values\"=>[\"gid://shopify/Metaobject/971662467\", \"gid://shopify/Metaobject/971662468\", \"gid://shopify/Metaobject/971662469\"]}}]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481047\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"linkedMetafield\": {\n \"namespace\": \"shopify\",\n \"key\": \"color-pattern\",\n \"values\": [\n \"gid://shopify/Metaobject/971662467\",\n \"gid://shopify/Metaobject/971662468\",\n \"gid://shopify/Metaobject/971662469\"\n ]\n }\n }\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481047\",\n \"options\" => [{\"name\"=>\"Color\", \"linkedMetafield\"=>{\"namespace\"=>\"shopify\", \"key\"=>\"color-pattern\", \"values\"=>[\"gid://shopify/Metaobject/971662467\", \"gid://shopify/Metaobject/971662468\", \"gid://shopify/Metaobject/971662469\"]}}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/1072481047\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"linkedMetafield\":{\"namespace\":\"shopify\",\"key\":\"color-pattern\",\"values\":[\"gid://shopify/Metaobject/971662467\",\"gid://shopify/Metaobject/971662468\",\"gid://shopify/Metaobject/971662469\"]}}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Create a product option linked to a metafield (with existing values)",
"description": "Use the `linkedMetafield` input to create options based on metafields and metaobjects.\nOptions can only be linked to [category metafields](https://help.shopify.com/manual/products/details/product-category#category-metafields).\nIf the category metafield contains a value for the given product, option values are created for every metaobject referenced by the metafield.\n\nMetafield-linked product options are only available in Shopify taxonomy early access.\n\n[Learn more about metafield-linked product options](https://shopify.dev/api/admin/migrate/new-product-model/metafield-linked).\n",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481046",
"options": [
{
"name": "Color",
"linkedMetafield": {
"namespace": "shopify",
"key": "color-pattern"
}
}
]
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [],
"product": {
"options": [
{
"name": "Color",
"linkedMetafield": {
"namespace": "shopify",
"key": "color-pattern"
},
"optionValues": [
{
"name": "Red",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662464"
},
{
"name": "Blue",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662465"
},
{
"name": "Yellow",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662466"
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481046\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"linkedMetafield\": {\n \"namespace\": \"shopify\",\n \"key\": \"color-pattern\"\n }\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481046\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"linkedMetafield\": {\n \"namespace\": \"shopify\",\n \"key\": \"color-pattern\"\n }\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481046\",\n \"options\": [{\"name\"=>\"Color\", \"linkedMetafield\"=>{\"namespace\"=>\"shopify\", \"key\"=>\"color-pattern\"}}]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481046\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"linkedMetafield\": {\n \"namespace\": \"shopify\",\n \"key\": \"color-pattern\"\n }\n }\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!) {\n productOptionsCreate(productId: $productId, options: $options) {\n userErrors {\n field\n message\n code\n }\n product {\n options {\n name\n linkedMetafield {\n namespace\n key\n }\n optionValues {\n name\n linkedMetafieldValue\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481046\",\n \"options\" => [{\"name\"=>\"Color\", \"linkedMetafield\"=>{\"namespace\"=>\"shopify\", \"key\"=>\"color-pattern\"}}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/1072481046\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"linkedMetafield\":{\"namespace\":\"shopify\",\"key\":\"color-pattern\"}}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Create new product option and variants with CREATE variantStrategy",
"description": "The CREATE variantStrategy will create new variants for each combination of option values.\n",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
{
"name": "Color",
"values": [
{
"name": "Blue"
},
{
"name": "Green"
}
]
}
],
"variantStrategy": "CREATE"
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/20995642",
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "151cm / Blue",
"selectedOptions": [
{
"name": "Title",
"value": "151cm"
},
{
"name": "Color",
"value": "Blue"
}
]
},
{
"id": "gid://shopify/ProductVariant/113711323",
"title": "155cm / Blue",
"selectedOptions": [
{
"name": "Title",
"value": "155cm"
},
{
"name": "Color",
"value": "Blue"
}
]
},
{
"id": "gid://shopify/ProductVariant/236948360",
"title": "158cm / Blue",
"selectedOptions": [
{
"name": "Title",
"value": "158cm"
},
{
"name": "Color",
"value": "Blue"
}
]
},
{
"id": "gid://shopify/ProductVariant/1070325032",
"title": "151cm / Green",
"selectedOptions": [
{
"name": "Title",
"value": "151cm"
},
{
"name": "Color",
"value": "Green"
}
]
},
{
"id": "gid://shopify/ProductVariant/1070325033",
"title": "155cm / Green",
"selectedOptions": [
{
"name": "Title",
"value": "155cm"
},
{
"name": "Color",
"value": "Green"
}
]
},
{
"id": "gid://shopify/ProductVariant/1070325034",
"title": "158cm / Green",
"selectedOptions": [
{
"name": "Title",
"value": "158cm"
},
{
"name": "Color",
"value": "Green"
}
]
}
]
},
"options": [
{
"id": "gid://shopify/ProductOption/328272167",
"name": "Title",
"values": [
"151cm",
"155cm",
"158cm"
],
"position": 1,
"optionValues": [
{
"name": "151cm",
"hasVariants": true
},
{
"name": "155cm",
"hasVariants": true
},
{
"name": "158cm",
"hasVariants": true
}
]
},
{
"id": "gid://shopify/ProductOption/1064576494",
"name": "Color",
"values": [
"Blue",
"Green"
],
"position": 2,
"optionValues": [
{
"name": "Blue",
"hasVariants": true
},
{
"name": "Green",
"hasVariants": true
}
]
}
]
}
}
}
},
"api_name": "admin",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) { productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) { userErrors { field message code } product { id variants(first: 10) { nodes { id title selectedOptions { name value } } } options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Green\"\n }\n ]\n }\n ],\n \"variantStrategy\": \"CREATE\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Green\"\n }\n ]\n }\n ],\n \"variantStrategy\": \"CREATE\"\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}, {\"name\"=>\"Green\"}]}],\n \"variantStrategy\": \"CREATE\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Green\"\n }\n ]\n }\n ],\n \"variantStrategy\": \"CREATE\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}, {\"name\"=>\"Green\"}]}],\n \"variantStrategy\" => \"CREATE\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"values\":[{\"name\":\"Blue\"},{\"name\":\"Green\"}]}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Create new product option but no new variants with LEAVE_AS_IS variantStrategy",
"description": "The LEAVE_AS_IS variantStrategy will create new options and update existing variants to be valid,\nbut create no new variants. This is the default behavior if variantStrategy is unspecified.\n",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
{
"name": "Color",
"values": [
{
"name": "Blue"
},
{
"name": "Green"
}
]
}
],
"variantStrategy": "LEAVE_AS_IS"
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/20995642",
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "151cm / Blue",
"selectedOptions": [
{
"name": "Title",
"value": "151cm"
},
{
"name": "Color",
"value": "Blue"
}
]
},
{
"id": "gid://shopify/ProductVariant/113711323",
"title": "155cm / Blue",
"selectedOptions": [
{
"name": "Title",
"value": "155cm"
},
{
"name": "Color",
"value": "Blue"
}
]
},
{
"id": "gid://shopify/ProductVariant/236948360",
"title": "158cm / Blue",
"selectedOptions": [
{
"name": "Title",
"value": "158cm"
},
{
"name": "Color",
"value": "Blue"
}
]
}
]
},
"options": [
{
"id": "gid://shopify/ProductOption/328272167",
"name": "Title",
"values": [
"151cm",
"155cm",
"158cm"
],
"position": 1,
"optionValues": [
{
"name": "151cm",
"hasVariants": true
},
{
"name": "155cm",
"hasVariants": true
},
{
"name": "158cm",
"hasVariants": true
}
]
},
{
"id": "gid://shopify/ProductOption/1064576487",
"name": "Color",
"values": [
"Blue"
],
"position": 2,
"optionValues": [
{
"name": "Blue",
"hasVariants": true
},
{
"name": "Green",
"hasVariants": false
}
]
}
]
}
}
}
},
"api_name": "admin",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) { productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) { userErrors { field message code } product { id variants(first: 10) { nodes { id title selectedOptions { name value } } } options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Green\"\n }\n ]\n }\n ],\n \"variantStrategy\": \"LEAVE_AS_IS\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Green\"\n }\n ]\n }\n ],\n \"variantStrategy\": \"LEAVE_AS_IS\"\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}, {\"name\"=>\"Green\"}]}],\n \"variantStrategy\": \"LEAVE_AS_IS\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Green\"\n }\n ]\n }\n ],\n \"variantStrategy\": \"LEAVE_AS_IS\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}, {\"name\"=>\"Green\"}]}],\n \"variantStrategy\" => \"LEAVE_AS_IS\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"values\":[{\"name\":\"Blue\"},{\"name\":\"Green\"}]}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Create new product option with an explicit position",
"description": "With explicitly specified valid position, the option will be created with this position on the product.\n",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
{
"name": "Color",
"position": 1,
"values": [
{
"name": "Blue"
}
]
}
]
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/20995642",
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "Blue / 151cm",
"selectedOptions": [
{
"name": "Color",
"value": "Blue"
},
{
"name": "Title",
"value": "151cm"
}
]
},
{
"id": "gid://shopify/ProductVariant/113711323",
"title": "Blue / 155cm",
"selectedOptions": [
{
"name": "Color",
"value": "Blue"
},
{
"name": "Title",
"value": "155cm"
}
]
},
{
"id": "gid://shopify/ProductVariant/236948360",
"title": "Blue / 158cm",
"selectedOptions": [
{
"name": "Color",
"value": "Blue"
},
{
"name": "Title",
"value": "158cm"
}
]
}
]
},
"options": [
{
"id": "gid://shopify/ProductOption/1064576488",
"name": "Color",
"values": [
"Blue"
],
"position": 1,
"optionValues": [
{
"name": "Blue",
"hasVariants": true
}
]
},
{
"id": "gid://shopify/ProductOption/328272167",
"name": "Title",
"values": [
"151cm",
"155cm",
"158cm"
],
"position": 2,
"optionValues": [
{
"name": "151cm",
"hasVariants": true
},
{
"name": "155cm",
"hasVariants": true
},
{
"name": "158cm",
"hasVariants": true
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) { productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) { userErrors { field message code } product { id variants(first: 10) { nodes { id title selectedOptions { name value } } } options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"position\": 1,\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"position\": 1,\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [{\"name\"=>\"Color\", \"position\"=>1, \"values\"=>[{\"name\"=>\"Blue\"}]}]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"position\": 1,\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [{\"name\"=>\"Color\", \"position\"=>1, \"values\"=>[{\"name\"=>\"Blue\"}]}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"position\":1,\"values\":[{\"name\":\"Blue\"}]}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Create new product options",
"description": "Creates new options on a product. If you call the mutation on with a product that has no explicit options,\nthen only the new options are created. When passing multiple option values,\nonly the first value is linked to the product variant.\n",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481045",
"options": [
{
"name": "Color",
"values": [
{
"name": "Blue"
},
{
"name": "Red"
}
]
},
{
"name": "Size",
"values": [
{
"name": "Small"
},
{
"name": "Medium"
}
]
}
]
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/1072481045",
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325031",
"title": "Blue / Small",
"selectedOptions": [
{
"name": "Color",
"value": "Blue"
},
{
"name": "Size",
"value": "Small"
}
]
}
]
},
"options": [
{
"id": "gid://shopify/ProductOption/1064576491",
"name": "Color",
"values": [
"Blue"
],
"position": 1,
"optionValues": [
{
"name": "Blue",
"hasVariants": true
},
{
"name": "Red",
"hasVariants": false
}
]
},
{
"id": "gid://shopify/ProductOption/1064576492",
"name": "Size",
"values": [
"Small"
],
"position": 2,
"optionValues": [
{
"name": "Small",
"hasVariants": true
},
{
"name": "Medium",
"hasVariants": false
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) { productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) { userErrors { field message code } product { id variants(first: 10) { nodes { id title selectedOptions { name value } } } options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481045\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Red\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n {\n \"name\": \"Small\"\n },\n {\n \"name\": \"Medium\"\n }\n ]\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481045\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Red\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n {\n \"name\": \"Small\"\n },\n {\n \"name\": \"Medium\"\n }\n ]\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481045\",\n \"options\": [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}, {\"name\"=>\"Red\"}]}, {\"name\"=>\"Size\", \"values\"=>[{\"name\"=>\"Small\"}, {\"name\"=>\"Medium\"}]}]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481045\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n },\n {\n \"name\": \"Red\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n {\n \"name\": \"Small\"\n },\n {\n \"name\": \"Medium\"\n }\n ]\n }\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481045\",\n \"options\" => [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}, {\"name\"=>\"Red\"}]}, {\"name\"=>\"Size\", \"values\"=>[{\"name\"=>\"Small\"}, {\"name\"=>\"Medium\"}]}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/1072481045\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"values\":[{\"name\":\"Blue\"},{\"name\":\"Red\"}]},{\"name\":\"Size\",\"values\":[{\"name\":\"Small\"},{\"name\":\"Medium\"}]}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Trying to create an option with a name that already exists on the product returns an error",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
{
"name": "Color",
"values": [
{
"name": "Blue"
}
]
}
]
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [
{
"field": [
"options",
"0"
],
"message": "Option 'Color' already exists.",
"code": "OPTION_ALREADY_EXISTS"
}
],
"product": {
"id": "gid://shopify/Product/20995642",
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "151cm / Green",
"selectedOptions": [
{
"name": "Title",
"value": "151cm"
},
{
"name": "Color",
"value": "Green"
}
]
},
{
"id": "gid://shopify/ProductVariant/113711323",
"title": "155cm / Green",
"selectedOptions": [
{
"name": "Title",
"value": "155cm"
},
{
"name": "Color",
"value": "Green"
}
]
},
{
"id": "gid://shopify/ProductVariant/236948360",
"title": "158cm / Green",
"selectedOptions": [
{
"name": "Title",
"value": "158cm"
},
{
"name": "Color",
"value": "Green"
}
]
}
]
},
"options": [
{
"id": "gid://shopify/ProductOption/328272167",
"name": "Title",
"values": [
"151cm",
"155cm",
"158cm"
],
"position": 1,
"optionValues": [
{
"id": "gid://shopify/ProductOptionValue/141051426",
"name": "151cm",
"hasVariants": true
},
{
"id": "gid://shopify/ProductOptionValue/258076414",
"name": "155cm",
"hasVariants": true
},
{
"id": "gid://shopify/ProductOptionValue/129596849",
"name": "158cm",
"hasVariants": true
}
]
},
{
"id": "gid://shopify/ProductOption/1064576495",
"name": "Color",
"values": [
"Green"
],
"position": 2,
"optionValues": [
{
"id": "gid://shopify/ProductOptionValue/1054672187",
"name": "Green",
"hasVariants": true
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) { productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) { userErrors { field message code } product { id variants(first: 10) { nodes { id title selectedOptions { name value } } } options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}]}]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}]}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"values\":[{\"name\":\"Blue\"}]}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionscreate",
"title": "Trying to create too many options returns an error",
"query_string": "mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
{
"name": "Color",
"values": [
{
"name": "Blue"
}
]
},
{
"name": "Style",
"values": [
{
"name": "Classic"
}
]
},
{
"name": "Size",
"values": [
{
"name": "Small"
}
]
},
{
"name": "Material",
"values": [
{
"name": "Linen"
}
]
}
]
},
"response": {
"data": {
"productOptionsCreate": {
"userErrors": [
{
"field": [
"options"
],
"message": "Can only specify a maximum of 3 options",
"code": "OPTIONS_OVER_LIMIT"
}
],
"product": {
"id": "gid://shopify/Product/20995642",
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/30322695",
"title": "151cm",
"selectedOptions": [
{
"name": "Title",
"value": "151cm"
}
]
},
{
"id": "gid://shopify/ProductVariant/113711323",
"title": "155cm",
"selectedOptions": [
{
"name": "Title",
"value": "155cm"
}
]
},
{
"id": "gid://shopify/ProductVariant/236948360",
"title": "158cm",
"selectedOptions": [
{
"name": "Title",
"value": "158cm"
}
]
}
]
},
"options": [
{
"id": "gid://shopify/ProductOption/328272167",
"name": "Title",
"values": [
"151cm",
"155cm",
"158cm"
],
"position": 1,
"optionValues": [
{
"id": "gid://shopify/ProductOptionValue/141051426",
"name": "151cm",
"hasVariants": true
},
{
"id": "gid://shopify/ProductOptionValue/258076414",
"name": "155cm",
"hasVariants": true
},
{
"id": "gid://shopify/ProductOptionValue/129596849",
"name": "158cm",
"hasVariants": true
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_options_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) { productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) { userErrors { field message code } product { id variants(first: 10) { nodes { id title selectedOptions { name value } } } options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Style\",\n \"values\": [\n {\n \"name\": \"Classic\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n {\n \"name\": \"Small\"\n }\n ]\n },\n {\n \"name\": \"Material\",\n \"values\": [\n {\n \"name\": \"Linen\"\n }\n ]\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Style\",\n \"values\": [\n {\n \"name\": \"Classic\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n {\n \"name\": \"Small\"\n }\n ]\n },\n {\n \"name\": \"Material\",\n \"values\": [\n {\n \"name\": \"Linen\"\n }\n ]\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\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 createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}]}, {\"name\"=>\"Style\", \"values\"=>[{\"name\"=>\"Classic\"}]}, {\"name\"=>\"Size\", \"values\"=>[{\"name\"=>\"Small\"}]}, {\"name\"=>\"Material\", \"values\"=>[{\"name\"=>\"Linen\"}]}]\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n {\n \"name\": \"Color\",\n \"values\": [\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Style\",\n \"values\": [\n {\n \"name\": \"Classic\"\n }\n ]\n },\n {\n \"name\": \"Size\",\n \"values\": [\n {\n \"name\": \"Small\"\n }\n ]\n },\n {\n \"name\": \"Material\",\n \"values\": [\n {\n \"name\": \"Linen\"\n }\n ]\n }\n ]\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation createOptions($productId: ID!, $options: [OptionCreateInput!]!, $variantStrategy: ProductOptionCreateVariantStrategy) {\n productOptionsCreate(productId: $productId, options: $options, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n variants(first: 10) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [{\"name\"=>\"Color\", \"values\"=>[{\"name\"=>\"Blue\"}]}, {\"name\"=>\"Style\", \"values\"=>[{\"name\"=>\"Classic\"}]}, {\"name\"=>\"Size\", \"values\"=>[{\"name\"=>\"Small\"}]}, {\"name\"=>\"Material\", \"values\"=>[{\"name\"=>\"Linen\"}]}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "options",
"description": "Options to add to the product.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionCreateInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[OptionCreateInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [{\"name\":\"Color\",\"values\":[{\"name\":\"Blue\"}]},{\"name\":\"Style\",\"values\":[{\"name\":\"Classic\"}]},{\"name\":\"Size\",\"values\":[{\"name\":\"Small\"}]},{\"name\":\"Material\",\"values\":[{\"name\":\"Linen\"}]}]",
"typeKind": "MUTATION"
}
]
}
]