892d737c1f
* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
267 lines
7.7 KiB
Plaintext
267 lines
7.7 KiB
Plaintext
---
|
|
displayed_sidebar: pricingReference
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# CalculatedPriceSet
|
|
|
|
The calculated price for a specific price set and context.
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "calculated_amount",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The amount of the calculated price, or `null` if there isn't a calculated price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "calculated_price",
|
|
"type": "`object`",
|
|
"description": "The details of the calculated price.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": [
|
|
{
|
|
"name": "max_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `max_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "min_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `min_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "money_amount_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the money amount selected as the calculated price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_type",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The type of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "calculated_price.max_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `max_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "calculated_price.min_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `min_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "calculated_price.money_amount_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the money amount selected as the calculated price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "calculated_price.price_list_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "calculated_price.price_list_type",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The type of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "currency_code",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The currency code of the calculated price, or null if there isn't a calculated price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The ID of the price set.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "is_calculated_price_price_list",
|
|
"type": "`boolean`",
|
|
"description": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found, \nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "is_original_price_price_list",
|
|
"type": "`boolean`",
|
|
"description": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override, \nthe original price will be the same as the calculated price. In that case, the value of this property is `true`.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_amount",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The amount of the original price, or `null` if there isn't a calculated price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_price",
|
|
"type": "`object`",
|
|
"description": "The details of the original price.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": [
|
|
{
|
|
"name": "max_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `max_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "min_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `min_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "money_amount_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the money amount selected as the original price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_type",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The type of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "original_price.max_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `max_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_price.min_quantity",
|
|
"type": "`null` \\| `number`",
|
|
"description": "The `min_quantity` field defined on a money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_price.money_amount_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the money amount selected as the original price.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_price.price_list_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_price.price_list_type",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The type of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|