asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
www/apps/docs/content/references/services/interfaces/CalculatedPriceSet.mdx Normal file
View File

@@ -0,0 +1,176 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CalculatedPriceSet
The calculated price for a specific price set and context.
## Properties
<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": "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, the 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, the 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": "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": []
}
]} />