Files
medusa-store/www/apps/docs/content/references/pricing/interfaces/pricing.PriceSetDTO.mdx
Shahed Nasser 892d737c1f docs: enhance how references are generated (#5805)
* 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
2023-12-05 15:29:41 +02:00

242 lines
7.2 KiB
Plaintext

---
displayed_sidebar: pricingReference
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# PriceSetDTO
A price set's data.
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
"type": "`number`",
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "code",
"type": "`string`",
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "symbol",
"type": "`string`",
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "symbol_native",
"type": "`string`",
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "currency_code",
"type": "`string`",
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "max_quantity",
"type": "`number`",
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`number`",
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_list",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_set",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
"type": "`number`",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />