c51dce164d
* fixed typedoc plugin's escape strategy * move props comments to the associated property * regenerate references
96 lines
2.1 KiB
Plaintext
96 lines
2.1 KiB
Plaintext
---
|
|
displayed_sidebar: servicesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# PriceRuleDTO
|
|
|
|
A price rule's data.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The ID of the price rule.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the associated price list.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_set",
|
|
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
|
|
"description": "The associated price set.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_set_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the associated price set.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_set_money_amount_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the associated price set money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "priority",
|
|
"type": "`number`",
|
|
"description": "The priority of the price rule in comparison to other applicable price rules.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "rule_type",
|
|
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
|
|
"description": "The associated rule type.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "rule_type_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the associated rule type.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "value",
|
|
"type": "`string`",
|
|
"description": "The value of the price rule.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|