Anchor to section titled 'undefined'quantity
quantity
mutation
2024-07
Requires write access scope. Also: The user must have a permission to add quantity rules to a price list.
Creates or updates existing quantity rules on a price list.
You can use the quantity mutation to set order level minimums, maximumums and increments for specific product variants.
Anchor to section titled 'Arguments'
Arguments
The ID of the price list to which the quantity rules will be added or updated.
The list of quantity rules to add or update in the price list.
Was this section helpful?
Anchor to section titled 'QuantityRulesAddPayload returns'
QuantityRulesAddPayload returns
The list of quantity rules that were added to or updated in the price list.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: quantityRulesAdd
Query Reference for MUTATION: quantityRulesAdd
"mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n quantityRules {\n # QuantityRule fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: quantityRulesAdd
"{\n \"priceListId\": \"gid://shopify/<objectName>/10079785100\",\n \"quantityRules\": [\n {\n \"increment\": 1,\n \"maximum\": 1,\n \"minimum\": 1,\n \"variantId\": \"gid://shopify/<objectName>/10079785100\"\n }\n ]\n}"Schema Reference for MUTATION: quantityRulesAdd
"input QuantityRuleInput {\n increment: Int!\n maximum: Int\n minimum: Int!\n variantId: ID!\n}\n"Display Examples for MUTATION: quantityRulesAdd
[
{
"example": {
"type_name": "quantityrulesadd",
"title": "Add multiple quantity rules to a price list",
"description": "Add quantity rules for two product variants",
"query_string": "mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n}",
"variables": {
"priceListId": "gid://shopify/PriceList/155157792",
"quantityRules": [
{
"variantId": "gid://shopify/ProductVariant/138327650",
"minimum": 1,
"maximum": null,
"increment": 1
},
{
"variantId": "gid://shopify/ProductVariant/113711323",
"minimum": 5,
"maximum": 25,
"increment": 5
}
]
},
"response": {
"data": {
"quantityRulesAdd": {
"userErrors": [],
"quantityRules": [
{
"minimum": 1,
"maximum": null,
"increment": 1,
"isDefault": true,
"originType": "FIXED",
"productVariant": {
"id": "gid://shopify/ProductVariant/138327650"
}
},
{
"minimum": 5,
"maximum": 25,
"increment": 5,
"isDefault": false,
"originType": "FIXED",
"productVariant": {
"id": "gid://shopify/ProductVariant/113711323"
}
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/quantity_rules_add_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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) { quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) { userErrors { field code message } quantityRules { minimum maximum increment isDefault originType productVariant { id } } } }\",\n \"variables\": {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [\n {\n \"variantId\": \"gid://shopify/ProductVariant/138327650\",\n \"minimum\": 1,\n \"maximum\": null,\n \"increment\": 1\n },\n {\n \"variantId\": \"gid://shopify/ProductVariant/113711323\",\n \"minimum\": 5,\n \"maximum\": 25,\n \"increment\": 5\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [\n {\n \"variantId\": \"gid://shopify/ProductVariant/138327650\",\n \"minimum\": 1,\n \"maximum\": null,\n \"increment\": 1\n },\n {\n \"variantId\": \"gid://shopify/ProductVariant/113711323\",\n \"minimum\": 5,\n \"maximum\": 25,\n \"increment\": 5\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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [{\"variantId\"=>\"gid://shopify/ProductVariant/138327650\", \"minimum\"=>1, \"maximum\"=>nil, \"increment\"=>1}, {\"variantId\"=>\"gid://shopify/ProductVariant/113711323\", \"minimum\"=>5, \"maximum\"=>25, \"increment\"=>5}]\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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [\n {\n \"variantId\": \"gid://shopify/ProductVariant/138327650\",\n \"minimum\": 1,\n \"maximum\": null,\n \"increment\": 1\n },\n {\n \"variantId\": \"gid://shopify/ProductVariant/113711323\",\n \"minimum\": 5,\n \"maximum\": 25,\n \"increment\": 5\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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"priceListId\" => \"gid://shopify/PriceList/155157792\",\n \"quantityRules\" => [{\"variantId\"=>\"gid://shopify/ProductVariant/138327650\", \"minimum\"=>1, \"maximum\"=>nil, \"increment\"=>1}, {\"variantId\"=>\"gid://shopify/ProductVariant/113711323\", \"minimum\"=>5, \"maximum\"=>25, \"increment\"=>5}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "priceListId",
"description": "The ID of the price list to which the quantity rules will be added or updated.",
"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/155157792\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "quantityRules",
"description": "The list of quantity rules to add or update in the price list.",
"type": {
"kind": "INPUT_OBJECT",
"name": "QuantityRuleInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[QuantityRuleInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "quantityRules",
"argValue": " [{\"variantId\":\"gid://shopify/ProductVariant/138327650\",\"minimum\":1,\"maximum\":null,\"increment\":1},{\"variantId\":\"gid://shopify/ProductVariant/113711323\",\"minimum\":5,\"maximum\":25,\"increment\":5}]",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "quantityrulesadd",
"title": "Adding invalid quantity rules returns an error",
"description": "Attempt to add quantity rules with invalid values",
"query_string": "mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n}",
"variables": {
"priceListId": "gid://shopify/PriceList/155157792",
"quantityRules": [
{
"variantId": "gid://shopify/ProductVariant/138327650",
"minimum": 1,
"maximum": 5,
"increment": 2
},
{
"variantId": "gid://shopify/ProductVariant/113711323",
"minimum": 10,
"maximum": 5,
"increment": 5
}
]
},
"response": {
"data": {
"quantityRulesAdd": {
"userErrors": [
{
"field": [
"quantityRules",
"0",
"increment"
],
"code": "INCREMENT_IS_GREATER_THAN_MINIMUM",
"message": "Increment must be lower than or equal to the minimum."
},
{
"field": [
"quantityRules",
"0",
"maximum"
],
"code": "MAXIMUM_NOT_MULTIPLE_OF_INCREMENT",
"message": "Maximum must be a multiple of the increment."
},
{
"field": [
"quantityRules",
"0",
"minimum"
],
"code": "MINIMUM_NOT_MULTIPLE_OF_INCREMENT",
"message": "Minimum must be a multiple of the increment."
},
{
"field": [
"quantityRules",
"1",
"minimum"
],
"code": "MINIMUM_IS_GREATER_THAN_MAXIMUM",
"message": "Minimum must be lower than or equal to the maximum."
}
],
"quantityRules": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/merchandising/graph_api/admin/mutations/quantity_rules_add_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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) { quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) { userErrors { field code message } quantityRules { minimum maximum increment isDefault originType productVariant { id } } } }\",\n \"variables\": {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [\n {\n \"variantId\": \"gid://shopify/ProductVariant/138327650\",\n \"minimum\": 1,\n \"maximum\": 5,\n \"increment\": 2\n },\n {\n \"variantId\": \"gid://shopify/ProductVariant/113711323\",\n \"minimum\": 10,\n \"maximum\": 5,\n \"increment\": 5\n }\n ]\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [\n {\n \"variantId\": \"gid://shopify/ProductVariant/138327650\",\n \"minimum\": 1,\n \"maximum\": 5,\n \"increment\": 2\n },\n {\n \"variantId\": \"gid://shopify/ProductVariant/113711323\",\n \"minimum\": 10,\n \"maximum\": 5,\n \"increment\": 5\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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [{\"variantId\"=>\"gid://shopify/ProductVariant/138327650\", \"minimum\"=>1, \"maximum\"=>5, \"increment\"=>2}, {\"variantId\"=>\"gid://shopify/ProductVariant/113711323\", \"minimum\"=>10, \"maximum\"=>5, \"increment\"=>5}]\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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"priceListId\": \"gid://shopify/PriceList/155157792\",\n \"quantityRules\": [\n {\n \"variantId\": \"gid://shopify/ProductVariant/138327650\",\n \"minimum\": 1,\n \"maximum\": 5,\n \"increment\": 2\n },\n {\n \"variantId\": \"gid://shopify/ProductVariant/113711323\",\n \"minimum\": 10,\n \"maximum\": 5,\n \"increment\": 5\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 quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {\n quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {\n userErrors {\n field\n code\n message\n }\n quantityRules {\n minimum\n maximum\n increment\n isDefault\n originType\n productVariant {\n id\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"priceListId\" => \"gid://shopify/PriceList/155157792\",\n \"quantityRules\" => [{\"variantId\"=>\"gid://shopify/ProductVariant/138327650\", \"minimum\"=>1, \"maximum\"=>5, \"increment\"=>2}, {\"variantId\"=>\"gid://shopify/ProductVariant/113711323\", \"minimum\"=>10, \"maximum\"=>5, \"increment\"=>5}],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "priceListId",
"description": "The ID of the price list to which the quantity rules will be added or updated.",
"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/155157792\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "quantityRules",
"description": "The list of quantity rules to add or update in the price list.",
"type": {
"kind": "INPUT_OBJECT",
"name": "QuantityRuleInput",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[QuantityRuleInput!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "quantityRules",
"argValue": " [{\"variantId\":\"gid://shopify/ProductVariant/138327650\",\"minimum\":1,\"maximum\":5,\"increment\":2},{\"variantId\":\"gid://shopify/ProductVariant/113711323\",\"minimum\":10,\"maximum\":5,\"increment\":5}]",
"typeKind": "MUTATION"
}
]
}
]