A price row on a price sheet discount, including cart spend ranges.
| Property | Description |
|---|---|
| id |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
| priceClass nullable |
How the price value is applied. |
| priceType nullable |
Whether this row is a percentage or dollar amount. |
| rangeHigh nullable |
Upper spend bound for a cart discount tier. Unused for other discount types. Blank or zero means unlimited. |
| rangeLow nullable |
Lower spend bound for a cart discount tier. Unused for other discount types. |
| shipping nullable |
Package shipping override, when applicable. |
| value nullable |
Percent or dollar value for this price row. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A price row on a price sheet discount, including cart spend ranges.",
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"priceClass": {
"description": "How the price value is applied.",
"enum": [
"off",
"for",
"forEach",
"forTotal",
"free",
"freeShipping"
],
"nullable": true,
"type": "string"
},
"priceType": {
"description": "Whether this row is a percentage or dollar amount.",
"enum": [
"percentage",
"dollar"
],
"nullable": true,
"type": "string"
},
"rangeHigh": {
"description": "Upper spend bound for a cart discount tier. Unused for other discount\ntypes. Blank or zero means unlimited.",
"nullable": true,
"type": "number"
},
"rangeLow": {
"description": "Lower spend bound for a cart discount tier. Unused for other discount types.",
"nullable": true,
"type": "number"
},
"shipping": {
"description": "Package shipping override, when applicable.",
"nullable": true,
"type": "number"
},
"value": {
"description": "Percent or dollar value for this price row.",
"nullable": true,
"type": "number"
}
},
"title": "Price Sheet Discount Price",
"type": "object"
}