quantityRulesAdd

mutation

Requires write_products access scope. Also: The user must have permission to create and edit catalogs, and the shop requires B2B features enabled.

Creates or updates existing quantity rules on a price list. You can use the quantityRulesAdd mutation to set order level minimums, maximumums and increments for specific product variants.

Arguments

Anchor to priceListIdpriceListId • ID!required: The ID of the price list to which the quantity rules will be added or updated.
Anchor to quantityRulesquantityRules • [QuantityRuleInput!]!required: The list of quantity rules to add or update in the price list.

Was this section helpful?

Anchor to QuantityRulesAddPayload returnsQuantityRulesAddPayload returns

Anchor to quantityRulesquantityRules • [QuantityRule!]: The list of quantity rules that were added to or updated in the price list.
Anchor to userErrorsuserErrors • [QuantityRuleUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Add multiple quantity rules to a price list
Adding invalid quantity rules returns an error
quantityRulesAdd reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {
6    quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {
7      userErrors {
8        field
9        code
10        message
11      }
12      quantityRules {
13        minimum
14        maximum
15        increment
16        isDefault
17        originType
18        productVariant {
19          id
20        }
21      }
22    }
23  }`,
24  {
25    variables: {
26      "priceListId": "gid://shopify/PriceList/155157792",
27      "quantityRules": [
28        {
29          "variantId": "gid://shopify/ProductVariant/138327650",
30          "minimum": 1,
31          "maximum": null,
32          "increment": 1
33        },
34        {
35          "variantId": "gid://shopify/ProductVariant/113711323",
36          "minimum": 5,
37          "maximum": 25,
38          "increment": 5
39        }
40      ]
41    },
42  },
43);
44
45const data = await response.json();
46

mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {
  quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {
    userErrors {
      field
      code
      message
    }
    quantityRules {
      minimum
      maximum
      increment
      isDefault
      originType
      productVariant {
        id
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) { quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) { userErrors { field code message } quantityRules { minimum maximum increment isDefault originType productVariant { id } } } }",
 "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
      }
    ]
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {
    quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {
      userErrors {
        field
        code
        message
      }
      quantityRules {
        minimum
        maximum
        increment
        isDefault
        originType
        productVariant {
          id
        }
      }
    }
  }`,
  {
    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
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {
      quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {
        userErrors {
          field
          code
          message
        }
        quantityRules {
          minimum
          maximum
          increment
          isDefault
          originType
          productVariant {
            id
          }
        }
      }
    }`,
    "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
        }
      ]
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation quantityRulesAdd($priceListId: ID!, $quantityRules: [QuantityRuleInput!]!) {
    quantityRulesAdd(priceListId: $priceListId, quantityRules: $quantityRules) {
      userErrors {
        field
        code
        message
      }
      quantityRules {
        minimum
        maximum
        increment
        isDefault
        originType
        productVariant {
          id
        }
      }
    }
  }
QUERY

variables = {
  "priceListId": "gid://shopify/PriceList/155157792",
  "quantityRules": [{"variantId"=>"gid://shopify/ProductVariant/138327650", "minimum"=>1, "maximum"=>nil, "increment"=>1}, {"variantId"=>"gid://shopify/ProductVariant/113711323", "minimum"=>5, "maximum"=>25, "increment"=>5}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "priceListId": "gid://shopify/PriceList/155157792",
3  "quantityRules": [
4    {
5      "variantId": "gid://shopify/ProductVariant/138327650",
6      "minimum": 1,
7      "maximum": null,
8      "increment": 1
9    },
10    {
11      "variantId": "gid://shopify/ProductVariant/113711323",
12      "minimum": 5,
13      "maximum": 25,
14      "increment": 5
15    }
16  ]
17}

Response

JSON

1{
2  "quantityRulesAdd": {
3    "userErrors": [],
4    "quantityRules": [
5      {
6        "minimum": 1,
7        "maximum": null,
8        "increment": 1,
9        "isDefault": true,
10        "originType": "FIXED",
11        "productVariant": {
12          "id": "gid://shopify/ProductVariant/138327650"
13        }
14      },
15      {
16        "minimum": 5,
17        "maximum": 25,
18        "increment": 5,
19        "isDefault": false,
20        "originType": "FIXED",
21        "productVariant": {
22          "id": "gid://shopify/ProductVariant/113711323"
23        }
24      }
25    ]
26  }
27}