BigCommerce · Schema
bulkPricingRule_Full
Common Bulk Pricing Rule properties
E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS
Properties
| Name | Type | Description |
|---|---|---|
| quantity_min | integer | The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. For `fixed` rules, the minimum quantity canʼt be less than two. Required in /POST. |
| quantity_max | integer | The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the `quantity_min` value – unless this field has a value of 0 (zero), in which case there will be no maximum boun |
| type | string | The type of adjustment that is made. Values: `price` - the adjustment amount per product; `percent` - the adjustment as a percentage of the original price; `fixed` - the adjusted absolute price of the |
| amount | object | You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments. Divide the adjustment percent |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/bulkPricingRule_Full",
"title": "bulkPricingRule_Full",
"type": "object",
"description": "Common Bulk Pricing Rule properties",
"x-internal": false,
"properties": {
"quantity_min": {
"minimum": 0,
"type": "integer",
"description": "The minimum inclusive quantity of a product to satisfy this rule. Must be greater than or equal to zero. For `fixed` rules, the minimum quantity can\u02bct be less than two.\nRequired in /POST.\n",
"example": 10,
"x-required": [
"post"
]
},
"quantity_max": {
"minimum": 0,
"type": "integer",
"description": "The maximum inclusive quantity of a product to satisfy this rule. Must be greater than the `quantity_min` value \u2013 unless this field has a value of 0 (zero), in which case there will be no maximum bound for this rule.\nRequired in /POST.",
"example": 50,
"x-required": [
"post"
]
},
"type": {
"type": "string",
"description": "The type of adjustment that is made. Values: `price` - the adjustment amount per product; `percent` - the adjustment as a percentage of the original price; `fixed` - the adjusted absolute price of the product.\nRequired in /POST.",
"example": "price",
"enum": [
"price",
"percent",
"fixed"
],
"x-required": [
"post"
]
},
"amount": {
"oneOf": [
{
"type": "number",
"example": 10
},
{
"type": "string",
"example": ".10"
}
],
"description": "You can express the adjustment type as either a fixed dollar amount or a percentage. Send a number; the response will return a number for `price` and `fixed` adjustments.\nDivide the adjustment percentage by 100 and send the result in string format. For example, represent 10% as \u201c.10\u201d. The response will return a float value for both `price` and `percentage` adjustments. \nRequired in /POST."
}
},
"required": [
"quantity_min",
"quantity_max",
"type",
"amount"
]
}