Anchor to section titled 'undefined'product
product
mutation
2024-07
Requires write access scope. Also: The user must have a permission to edit products and manage product variants.
Updates a product option.
Anchor to section titled 'Arguments'
Arguments
Option to update.
- Anchor to optionValuesToAddoptionValuesToAdd
New option values to create.
- Anchor to optionValuesToDeleteoptionValuesToDelete
IDs of the existing option values to delete.
- Anchor to optionValuesToUpdateoptionValuesToUpdate
Existing option values to update.
The ID of the Product the Option belongs to.
- Anchor to variantStrategyvariantStrategy
The strategy defines which behavior the mutation should observe regarding variants, such as creating variants or deleting them in response to option values to add or to delete. If not provided or set to null, the strategy
Lwill be used.E A V E _A S _I S
Was this section helpful?
Anchor to section titled 'ProductOptionUpdatePayload returns'
ProductOptionUpdatePayload returns
The product with which the option being updated is associated.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productOptionUpdate
Query Reference for MUTATION: productOptionUpdate
"mutation productOptionUpdate($option: OptionUpdateInput!, $productId: ID!) {\n productOptionUpdate(option: $option, productId: $productId) {\n product {\n # Product fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productOptionUpdate
"{\n \"option\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"linkedMetafield\": {\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\"\n },\n \"name\": \"<your-name>\",\n \"position\": 1\n },\n \"optionValuesToAdd\": [\n {\n \"linkedMetafieldValue\": \"<your-linkedMetafieldValue>\",\n \"name\": \"<your-name>\"\n }\n ],\n \"optionValuesToDelete\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"linkedMetafieldValue\": \"<your-linkedMetafieldValue>\",\n \"name\": \"<your-name>\"\n }\n ],\n \"productId\": \"gid://shopify/<objectName>/10079785100\",\n \"variantStrategy\": \"LEAVE_AS_IS\"\n}"Schema Reference for MUTATION: productOptionUpdate
"input OptionUpdateInput {\n id: ID!\n linkedMetafield: LinkedMetafieldUpdateInput\n name: String\n position: Int\n}\n\ninput LinkedMetafieldUpdateInput {\n key: String!\n namespace: String!\n}\n\ninput OptionValueCreateInput {\n linkedMetafieldValue: String\n name: String\n}\n\ninput OptionValueUpdateInput {\n id: ID!\n linkedMetafieldValue: String\n name: String\n}\n"Display Examples for MUTATION: productOptionUpdate
[
{
"example": {
"type_name": "productoptionupdate",
"title": "Add 2 new option values and update an existing one",
"description": "Values to be added must not contain an `id` field. Values to be updated must contain the `id` field.\n",
"query_string": "mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481063",
"option": {
"id": "gid://shopify/ProductOption/1064576526"
},
"optionValuesToAdd": [
{
"name": "Yellow"
},
{
"name": "Red"
}
],
"optionValuesToUpdate": [
{
"id": "gid://shopify/ProductOptionValue/1054672275",
"name": "Purple"
}
]
},
"response": {
"data": {
"productOptionUpdate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/1072481063",
"options": [
{
"id": "gid://shopify/ProductOption/1064576526",
"name": "Color",
"values": [
"Purple"
],
"position": 1,
"optionValues": [
{
"name": "Purple",
"hasVariants": true
},
{
"name": "Yellow",
"hasVariants": false
},
{
"name": "Red",
"hasVariants": false
}
]
}
],
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325103",
"title": "Purple",
"selectedOptions": [
{
"name": "Color",
"value": "Purple"
}
]
}
]
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_option_update_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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) { productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) { userErrors { field message code } product { id options { id name values position optionValues { id name hasVariants } } variants(first: 5) { nodes { id title selectedOptions { name value } } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481063\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576526\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Yellow\"\n },\n {\n \"name\": \"Red\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672275\",\n \"name\": \"Purple\"\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481063\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576526\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Yellow\"\n },\n {\n \"name\": \"Red\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672275\",\n \"name\": \"Purple\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481063\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576526\"\n },\n \"optionValuesToAdd\": [{\"name\"=>\"Yellow\"}, {\"name\"=>\"Red\"}],\n \"optionValuesToUpdate\": [{\"id\"=>\"gid://shopify/ProductOptionValue/1054672275\", \"name\"=>\"Purple\"}]\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481063\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576526\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Yellow\"\n },\n {\n \"name\": \"Red\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672275\",\n \"name\": \"Purple\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481063\",\n \"option\" => [\n \"id\" => \"gid://shopify/ProductOption/1064576526\",\n ],\n \"optionValuesToAdd\" => [{\"name\"=>\"Yellow\"}, {\"name\"=>\"Red\"}],\n \"optionValuesToUpdate\" => [{\"id\"=>\"gid://shopify/ProductOptionValue/1054672275\", \"name\"=>\"Purple\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the Product the Option belongs to.",
"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/1072481063\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "option",
"description": "Option to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OptionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "option",
"argValue": " {\"id\":\"gid://shopify/ProductOption/1064576526\"}",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToAdd",
"description": "New option values to create.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueCreateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueCreateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToAdd",
"argValue": " [{\"name\":\"Yellow\"},{\"name\":\"Red\"}]",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToUpdate",
"description": "Existing option values to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueUpdateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueUpdateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToUpdate",
"argValue": " [{\"id\":\"gid://shopify/ProductOptionValue/1054672275\",\"name\":\"Purple\"}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionupdate",
"title": "Replace a value with another",
"description": "Existing value \"Small\" is renamed to \"Medium\", and \"Small\" is added\nas a new option value without linked variants.\n",
"query_string": "mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481069",
"option": {
"id": "gid://shopify/ProductOption/1064576533"
},
"optionValuesToAdd": [
{
"name": "Small"
}
],
"optionValuesToUpdate": [
{
"id": "gid://shopify/ProductOptionValue/1054672293",
"name": "Medium"
}
]
},
"response": {
"data": {
"productOptionUpdate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/1072481069",
"options": [
{
"id": "gid://shopify/ProductOption/1064576532",
"name": "Color",
"values": [
"Blue",
"Green"
],
"position": 1,
"optionValues": [
{
"name": "Blue",
"hasVariants": true
},
{
"name": "Green",
"hasVariants": true
}
]
},
{
"id": "gid://shopify/ProductOption/1064576533",
"name": "Size",
"values": [
"Medium"
],
"position": 2,
"optionValues": [
{
"name": "Medium",
"hasVariants": true
},
{
"name": "Small",
"hasVariants": false
}
]
}
],
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325113",
"title": "Blue / Medium",
"selectedOptions": [
{
"name": "Color",
"value": "Blue"
},
{
"name": "Size",
"value": "Medium"
}
]
},
{
"id": "gid://shopify/ProductVariant/1070325114",
"title": "Green / Medium",
"selectedOptions": [
{
"name": "Color",
"value": "Green"
},
{
"name": "Size",
"value": "Medium"
}
]
}
]
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_option_update_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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) { productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) { userErrors { field message code } product { id options { id name values position optionValues { id name hasVariants } } variants(first: 5) { nodes { id title selectedOptions { name value } } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481069\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576533\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Small\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672293\",\n \"name\": \"Medium\"\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481069\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576533\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Small\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672293\",\n \"name\": \"Medium\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481069\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576533\"\n },\n \"optionValuesToAdd\": [{\"name\"=>\"Small\"}],\n \"optionValuesToUpdate\": [{\"id\"=>\"gid://shopify/ProductOptionValue/1054672293\", \"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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481069\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576533\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Small\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672293\",\n \"name\": \"Medium\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481069\",\n \"option\" => [\n \"id\" => \"gid://shopify/ProductOption/1064576533\",\n ],\n \"optionValuesToAdd\" => [{\"name\"=>\"Small\"}],\n \"optionValuesToUpdate\" => [{\"id\"=>\"gid://shopify/ProductOptionValue/1054672293\", \"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 the Option belongs to.",
"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/1072481069\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "option",
"description": "Option to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OptionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "option",
"argValue": " {\"id\":\"gid://shopify/ProductOption/1064576533\"}",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToAdd",
"description": "New option values to create.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueCreateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueCreateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToAdd",
"argValue": " [{\"name\":\"Small\"}]",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToUpdate",
"description": "Existing option values to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueUpdateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueUpdateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToUpdate",
"argValue": " [{\"id\":\"gid://shopify/ProductOptionValue/1054672293\",\"name\":\"Medium\"}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionupdate",
"title": "Trying to add an option value with a name that already exists returns an error",
"description": "Values to be added must not contain an `id` field. Values to be updated must contain the `id` field.\n",
"query_string": "mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481067",
"option": {
"id": "gid://shopify/ProductOption/1064576530"
},
"optionValuesToAdd": [
{
"name": "Red"
},
{
"name": "Blue"
}
]
},
"response": {
"data": {
"productOptionUpdate": {
"userErrors": [
{
"field": [
"optionValuesToAdd",
"1",
"name"
],
"message": "Option value already exists.",
"code": "OPTION_VALUE_ALREADY_EXISTS"
}
],
"product": {
"id": "gid://shopify/Product/1072481067",
"options": [
{
"id": "gid://shopify/ProductOption/1064576530",
"name": "Color",
"values": [
"Blue"
],
"position": 1,
"optionValues": [
{
"id": "gid://shopify/ProductOptionValue/1054672288",
"name": "Blue",
"hasVariants": true
}
]
}
],
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325110",
"title": "Blue",
"selectedOptions": [
{
"name": "Color",
"value": "Blue"
}
]
}
]
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_option_update_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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) { productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) { userErrors { field message code } product { id options { id name values position optionValues { id name hasVariants } } variants(first: 5) { nodes { id title selectedOptions { name value } } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481067\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576530\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Red\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481067\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576530\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Red\"\n },\n {\n \"name\": \"Blue\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481067\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576530\"\n },\n \"optionValuesToAdd\": [{\"name\"=>\"Red\"}, {\"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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481067\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576530\"\n },\n \"optionValuesToAdd\": [\n {\n \"name\": \"Red\"\n },\n {\n \"name\": \"Blue\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481067\",\n \"option\" => [\n \"id\" => \"gid://shopify/ProductOption/1064576530\",\n ],\n \"optionValuesToAdd\" => [{\"name\"=>\"Red\"}, {\"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 the Option belongs to.",
"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/1072481067\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "option",
"description": "Option to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OptionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "option",
"argValue": " {\"id\":\"gid://shopify/ProductOption/1064576530\"}",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToAdd",
"description": "New option values to create.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueCreateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueCreateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToAdd",
"argValue": " [{\"name\":\"Red\"},{\"name\":\"Blue\"}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionupdate",
"title": "Update name and position of an option",
"description": "Updates the name and position of a product option. The position must be a positive number\nbetween 1 and the number of options. The name length must be less than or equal to the maximum\nallowed option name length (255 characters).\n",
"query_string": "mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/1072481071",
"option": {
"id": "gid://shopify/ProductOption/1064576536",
"position": 1,
"name": "Tint"
}
},
"response": {
"data": {
"productOptionUpdate": {
"userErrors": [],
"product": {
"id": "gid://shopify/Product/1072481071",
"options": [
{
"id": "gid://shopify/ProductOption/1064576536",
"name": "Tint",
"values": [
"Blue",
"Red"
],
"position": 1,
"optionValues": [
{
"name": "Blue",
"hasVariants": true
},
{
"name": "Red",
"hasVariants": true
}
]
},
{
"id": "gid://shopify/ProductOption/1064576535",
"name": "Size",
"values": [
"Small",
"Medium"
],
"position": 2,
"optionValues": [
{
"name": "Small",
"hasVariants": true
},
{
"name": "Medium",
"hasVariants": true
}
]
}
],
"variants": {
"nodes": [
{
"id": "gid://shopify/ProductVariant/1070325117",
"title": "Blue / Small",
"selectedOptions": [
{
"name": "Tint",
"value": "Blue"
},
{
"name": "Size",
"value": "Small"
}
]
},
{
"id": "gid://shopify/ProductVariant/1070325118",
"title": "Red / Medium",
"selectedOptions": [
{
"name": "Tint",
"value": "Red"
},
{
"name": "Size",
"value": "Medium"
}
]
}
]
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_option_update_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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) { productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) { userErrors { field message code } product { id options { id name values position optionValues { id name hasVariants } } variants(first: 5) { nodes { id title selectedOptions { name value } } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481071\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576536\",\n \"position\": 1,\n \"name\": \"Tint\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/1072481071\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576536\",\n \"position\": 1,\n \"name\": \"Tint\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/1072481071\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576536\",\n \"position\": 1,\n \"name\": \"Tint\"\n }\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481071\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576536\",\n \"position\": 1,\n \"name\": \"Tint\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!], $variantStrategy: ProductOptionUpdateVariantStrategy) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete, variantStrategy: $variantStrategy) {\n userErrors {\n field\n message\n code\n }\n product {\n id\n options {\n id\n name\n values\n position\n optionValues {\n id\n name\n hasVariants\n }\n }\n variants(first: 5) {\n nodes {\n id\n title\n selectedOptions {\n name\n value\n }\n }\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/1072481071\",\n \"option\" => [\n \"id\" => \"gid://shopify/ProductOption/1064576536\",\n \"position\" => 1,\n \"name\" => \"Tint\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the Product the Option belongs to.",
"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/1072481071\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "option",
"description": "Option to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OptionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "option",
"argValue": " {\"id\":\"gid://shopify/ProductOption/1064576536\",\"position\":1,\"name\":\"Tint\"}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionupdate",
"title": "Update the values of an option linked to a metafield",
"description": "Use the `linkedMetafieldValue` field to link metaobjects to option values.\nThe referenced metaobject must be a valid value for the linked metafield.\nLearn about creating linked options in [productOptionsCreate](https://shopify.dev/api/admin-graphql/unstable/mutations/productOptionsCreate).\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!]) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete) {\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/1072481065",
"option": {
"id": "gid://shopify/ProductOption/1064576528"
},
"optionValuesToAdd": [
{
"linkedMetafieldValue": "gid://shopify/Metaobject/971662473"
}
],
"optionValuesToUpdate": [
{
"id": "gid://shopify/ProductOptionValue/1054672281",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662474"
}
]
},
"response": {
"data": {
"productOptionUpdate": {
"userErrors": [],
"product": {
"options": [
{
"name": "Color",
"linkedMetafield": {
"namespace": "shopify",
"key": "color-pattern"
},
"optionValues": [
{
"name": "White",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662474"
},
{
"name": "Blue",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662472"
},
{
"name": "Yellow",
"linkedMetafieldValue": "gid://shopify/Metaobject/971662473"
}
]
}
]
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_option_update_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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!]) { productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete) { userErrors { field message code } product { options { name linkedMetafield { namespace key } optionValues { name linkedMetafieldValue } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/1072481065\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576528\"\n },\n \"optionValuesToAdd\": [\n {\n \"linkedMetafieldValue\": \"gid://shopify/Metaobject/971662473\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672281\",\n \"linkedMetafieldValue\": \"gid://shopify/Metaobject/971662474\"\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!]) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete) {\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/1072481065\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576528\"\n },\n \"optionValuesToAdd\": [\n {\n \"linkedMetafieldValue\": \"gid://shopify/Metaobject/971662473\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672281\",\n \"linkedMetafieldValue\": \"gid://shopify/Metaobject/971662474\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!]) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete) {\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/1072481065\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576528\"\n },\n \"optionValuesToAdd\": [{\"linkedMetafieldValue\"=>\"gid://shopify/Metaobject/971662473\"}],\n \"optionValuesToUpdate\": [{\"id\"=>\"gid://shopify/ProductOptionValue/1054672281\", \"linkedMetafieldValue\"=>\"gid://shopify/Metaobject/971662474\"}]\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!]) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete) {\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/1072481065\",\n \"option\": {\n \"id\": \"gid://shopify/ProductOption/1064576528\"\n },\n \"optionValuesToAdd\": [\n {\n \"linkedMetafieldValue\": \"gid://shopify/Metaobject/971662473\"\n }\n ],\n \"optionValuesToUpdate\": [\n {\n \"id\": \"gid://shopify/ProductOptionValue/1054672281\",\n \"linkedMetafieldValue\": \"gid://shopify/Metaobject/971662474\"\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 updateOption($productId: ID!, $option: OptionUpdateInput!, $optionValuesToAdd: [OptionValueCreateInput!], $optionValuesToUpdate: [OptionValueUpdateInput!], $optionValuesToDelete: [ID!]) {\n productOptionUpdate(productId: $productId, option: $option, optionValuesToAdd: $optionValuesToAdd, optionValuesToUpdate: $optionValuesToUpdate, optionValuesToDelete: $optionValuesToDelete) {\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/1072481065\",\n \"option\" => [\n \"id\" => \"gid://shopify/ProductOption/1064576528\",\n ],\n \"optionValuesToAdd\" => [{\"linkedMetafieldValue\"=>\"gid://shopify/Metaobject/971662473\"}],\n \"optionValuesToUpdate\" => [{\"id\"=>\"gid://shopify/ProductOptionValue/1054672281\", \"linkedMetafieldValue\"=>\"gid://shopify/Metaobject/971662474\"}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the Product the Option belongs to.",
"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/1072481065\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "option",
"description": "Option to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionUpdateInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OptionUpdateInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "option",
"argValue": " {\"id\":\"gid://shopify/ProductOption/1064576528\"}",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToAdd",
"description": "New option values to create.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueCreateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueCreateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToAdd",
"argValue": " [{\"linkedMetafieldValue\":\"gid://shopify/Metaobject/971662473\"}]",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "optionValuesToUpdate",
"description": "Existing option values to update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OptionValueUpdateInput",
"list": true,
"non_null": false
},
"defaultValue": null,
"typeSignature": "[OptionValueUpdateInput!]",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "optionValuesToUpdate",
"argValue": " [{\"id\":\"gid://shopify/ProductOptionValue/1054672281\",\"linkedMetafieldValue\":\"gid://shopify/Metaobject/971662474\"}]",
"typeKind": "MUTATION"
}
]
}
]