Anchor to section titled 'undefined'quantity
quantity
mutation
2024-04
Requires write access scope. Also: The user must have a permission to delete quantity rules from a price list.
Deletes specific quantity rules from a price list using a product variant ID.
You can use the quantity mutation to delete a set of quantity rules from a price list.
Anchor to section titled 'Arguments'
Arguments
The ID of the price list from which the quantity rules will be deleted.
A list of product variant IDs whose quantity rules will be removed from the price list.
Was this section helpful?
Anchor to section titled 'QuantityRulesDeletePayload returns'
QuantityRulesDeletePayload returns
- Anchor to QuantityRulesDeletePayload.deletedQuantityRulesVariantIdsdeleted
Quantity Rules Variant Ids A list of product variant IDs whose quantity rules were removed from the price list.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: quantityRulesDelete
Query Reference for MUTATION: quantityRulesDelete
"mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n deletedQuantityRulesVariantIds\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: quantityRulesDelete
"{\n \"priceListId\": \"gid://shopify/<objectName>/10079785100\",\n \"variantIds\": [\n \"gid://shopify/<objectName>/10079785100\"\n ]\n}"Schema Reference for MUTATION: quantityRulesDelete
""
Display Examples for MUTATION: quantityRulesDelete
[
{
"example": {
"type_name": "quantityrulesdelete",
"title": "Delete multiple quantity rules from a price list",
"description": "Delete quantity rules for two product variants",
"query_string": "mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n deletedQuantityRulesVariantIds\n userErrors {\n field\n code\n message\n }\n }\n}",
"variables": {
"priceListId": "gid://shopify/PriceList/225060712",
"variantIds": [
"gid://shopify/ProductVariant/43729076",
"gid://shopify/ProductVariant/138327650"
]
},
"response": {
"data": {
"quantityRulesDelete": {
"deletedQuantityRulesVariantIds": [
"gid://shopify/ProductVariant/43729076",
"gid://shopify/ProductVariant/138327650"
],
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/quantity_rules_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 quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) { quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) { deletedQuantityRulesVariantIds userErrors { field code message } } }\",\n \"variables\": {\n \"priceListId\": \"gid://shopify/PriceList/225060712\",\n \"variantIds\": [\n \"gid://shopify/ProductVariant/43729076\",\n \"gid://shopify/ProductVariant/138327650\"\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n deletedQuantityRulesVariantIds\n userErrors {\n field\n code\n message\n }\n }\n }`,\n {\n variables: {\n \"priceListId\": \"gid://shopify/PriceList/225060712\",\n \"variantIds\": [\n \"gid://shopify/ProductVariant/43729076\",\n \"gid://shopify/ProductVariant/138327650\"\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 quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n deletedQuantityRulesVariantIds\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"priceListId\": \"gid://shopify/PriceList/225060712\",\n \"variantIds\": [\"gid://shopify/ProductVariant/43729076\", \"gid://shopify/ProductVariant/138327650\"]\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 quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n deletedQuantityRulesVariantIds\n userErrors {\n field\n code\n message\n }\n }\n }`,\n \"variables\": {\n \"priceListId\": \"gid://shopify/PriceList/225060712\",\n \"variantIds\": [\n \"gid://shopify/ProductVariant/43729076\",\n \"gid://shopify/ProductVariant/138327650\"\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 quantityRulesDelete($priceListId: ID!, $variantIds: [ID!]!) {\n quantityRulesDelete(priceListId: $priceListId, variantIds: $variantIds) {\n deletedQuantityRulesVariantIds\n userErrors {\n field\n code\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"priceListId\" => \"gid://shopify/PriceList/225060712\",\n \"variantIds\" => [\"gid://shopify/ProductVariant/43729076\", \"gid://shopify/ProductVariant/138327650\"],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "priceListId",
"description": "The ID of the price list from which the quantity rules will be deleted.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "priceListId",
"argValue": " \"gid://shopify/PriceList/225060712\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "variantIds",
"description": "A list of product variant IDs whose quantity rules will be removed from the price list.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[ID!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "variantIds",
"argValue": " [\"gid://shopify/ProductVariant/43729076\",\"gid://shopify/ProductVariant/138327650\"]",
"typeKind": "MUTATION"
}
]
}
]