Anchor to section titled 'undefined'product
product
mutation
2024-04
Requires write access scope. Also: The user must have a permission to edit products and delete product variants.
Deletes the specified options.
Anchor to section titled 'Arguments'
Arguments
IDs of the options to delete from the product.
ID of the product from which to delete the options.
The strategy defines which behavior the mutation should observe,such as how to handle a situation where deleting an option would result in duplicate variants.
Was this section helpful?
Anchor to section titled 'ProductOptionsDeletePayload returns'
ProductOptionsDeletePayload returns
- Anchor to ProductOptionsDeletePayload.deletedOptionsIdsdeleted
Options Ids IDs of the options deleted.
The updated product object.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productOptionsDelete
Query Reference for MUTATION: productOptionsDelete
"mutation productOptionsDelete($options: [ID!]!, $productId: ID!) {\n productOptionsDelete(options: $options, productId: $productId) {\n deletedOptionsIds\n product {\n # Product fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productOptionsDelete
"{\n \"options\": [\n \"gid://shopify/<objectName>/10079785100\"\n ],\n \"productId\": \"gid://shopify/<objectName>/10079785100\",\n \"strategy\": \"DEFAULT\"\n}"Schema Reference for MUTATION: productOptionsDelete
""
Display Examples for MUTATION: productOptionsDelete
[
{
"example": {
"type_name": "productoptionsdelete",
"title": "Delete an option",
"description": "Deletes options on a product. If the `strategy` field isn't specified or set to `DEFAULT`,\nthen no product variants associated with option will be deleted.\nIn cases where deleting an option would result in conflicting variants, an error is returned.\n",
"query_string": "mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
"gid://shopify/ProductOption/1064576514"
]
},
"response": {
"data": {
"productOptionsDelete": {
"userErrors": [],
"deletedOptionsIds": [
"gid://shopify/ProductOption/1064576514"
],
"product": {
"id": "gid://shopify/Product/20995642",
"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_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) { productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) { userErrors { field message code } deletedOptionsIds product { id options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/1064576514\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/1064576514\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\"gid://shopify/ProductOption/1064576514\"]\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/1064576514\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [\"gid://shopify/ProductOption/1064576514\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "ID of the product from which to delete the options.",
"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": "IDs of the options to delete from the product.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [\"gid://shopify/ProductOption/1064576514\"]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionsdelete",
"title": "Delete an option with the POSITION delete strategy",
"description": "With strategy field set to POSITION, only variants with unique combinations\nof the remaining option values will be kept, prioritizing ones with the lowest position.\n",
"query_string": "mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
"gid://shopify/ProductOption/328272167"
],
"strategy": "POSITION"
},
"response": {
"data": {
"productOptionsDelete": {
"userErrors": [],
"deletedOptionsIds": [
"gid://shopify/ProductOption/328272167"
],
"product": {
"id": "gid://shopify/Product/20995642",
"options": [
{
"id": "gid://shopify/ProductOption/1064576513",
"name": "Title",
"values": [
"Default Title"
],
"position": 1,
"optionValues": [
{
"id": "gid://shopify/ProductOptionValue/1054672239",
"name": "Default Title",
"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_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) { productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) { userErrors { field message code } deletedOptionsIds product { id options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/328272167\"\n ],\n \"strategy\": \"POSITION\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/328272167\"\n ],\n \"strategy\": \"POSITION\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\"gid://shopify/ProductOption/328272167\"],\n \"strategy\": \"POSITION\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/328272167\"\n ],\n \"strategy\": \"POSITION\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [\"gid://shopify/ProductOption/328272167\"],\n \"strategy\" => \"POSITION\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "ID of the product from which to delete the options.",
"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": "IDs of the options to delete from the product.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [\"gid://shopify/ProductOption/328272167\"]",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "strategy",
"description": "The strategy defines which behavior the mutation should observe,such as how to handle a situation where deleting an option would result in duplicate variants.",
"type": {
"kind": "ENUM",
"name": "ProductOptionDeleteStrategy",
"list": false,
"non_null": false
},
"defaultValue": "DEFAULT",
"typeSignature": "ProductOptionDeleteStrategy",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "strategy",
"argValue": " \"POSITION\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productoptionsdelete",
"title": "Trying to delete an option with multiple option values linked to variants with no option delete strategy\n returns an error",
"query_string": "mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/20995642",
"options": [
"gid://shopify/ProductOption/328272167"
]
},
"response": {
"data": {
"productOptionsDelete": {
"userErrors": [
{
"field": [
"options"
],
"message": "Cannot delete an option with multiple values.",
"code": "CANNOT_DELETE_OPTION_WITH_MULTIPLE_VALUES"
}
],
"deletedOptionsIds": [],
"product": {
"id": "gid://shopify/Product/20995642",
"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_delete_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) { productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) { userErrors { field message code } deletedOptionsIds product { id options { id name values position optionValues { id name hasVariants } } } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/328272167\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/328272167\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\"gid://shopify/ProductOption/328272167\"]\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/20995642\",\n \"options\": [\n \"gid://shopify/ProductOption/328272167\"\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 deleteOptions($productId: ID!, $options: [ID!]!, $strategy: ProductOptionDeleteStrategy) {\n productOptionsDelete(productId: $productId, options: $options, strategy: $strategy) {\n userErrors {\n field\n message\n code\n }\n deletedOptionsIds\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 }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/20995642\",\n \"options\" => [\"gid://shopify/ProductOption/328272167\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "ID of the product from which to delete the options.",
"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": "IDs of the options to delete from the product.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "options",
"argValue": " [\"gid://shopify/ProductOption/328272167\"]",
"typeKind": "MUTATION"
}
]
}
]