chore(docs): Generated References (#6222)
Generated the following references: - `entities` - `file` - `fulfillment` - `inventory` - `js_client` - `medusa` - `medusa_config` - `medusa_react` - `modules` - `notification` - `payment` - `price_selection` - `pricing` - `product` - `search` - `services` - `stock_location` - `tax` - `tax_calculation` - `types` - `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:
1463 files changed
+359543
-335590
No files matched your search
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The prices to be added to a price list.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"The ID of the price list to add prices to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]","description":"The prices to add.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"The ID of the price list to add prices to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]","description":"The prices to add.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AddPriceListPricesDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The prices to add to a price set.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"priceSetId","type":"`string`","description":"The ID of the price set to add prices to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreatePricesDTO](pricing.CreatePricesDTO.mdx)[]","description":"The prices to add to the price set.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"priceSetId","type":"`string`","description":"The ID of the price set to add prices to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[CreatePricesDTO](pricing.CreatePricesDTO.mdx)[]","description":"The prices to add to the price set.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AddPricesDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The rules to add to a price set.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"priceSetId","type":"`string`","description":"The ID of the price set to add the rules to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"The rules to add to a price set.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"The value of the rule's `rule_attribute` attribute.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"priceSetId","type":"`string`","description":"The ID of the price set to add the rules to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`object`[]","description":"The rules to add to a price set.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"`string`","description":"The value of the rule's `rule_attribute` attribute.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AddRulesDTO"/>
|
||||
@@ -10,6 +10,6 @@ An object used to allow specifying flexible queries with and/or conditions.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseFilterable"/>
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"(T \\| [BaseFilterable](pricing.BaseFilterable.mdx)<T>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(T \\| [BaseFilterable](pricing.BaseFilterable.mdx)<T>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"(T \\| [BaseFilterable](pricing.BaseFilterable.mdx)<T>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(T \\| [BaseFilterable](pricing.BaseFilterable.mdx)<T>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BaseFilterable"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
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.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":"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.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":[]},{"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":"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_price","type":"`object`","description":"The details of the original price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"Line truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"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":"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":"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":"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":"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.max_quantity","type":"`null` \\| `number`","description":"The `max_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":[]},{"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.max_quantity","type":"`null` \\| `number`","description":"The `max_quantity` field defined on a money amount.","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":"calculated_price","type":"`object`","description":"The details of the calculated price.","optional":true,"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":"min_quantity","type":"`null` \\| `number`","description":"The `min_quantity` field defined on a money amount.","optional":false,"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":"original_price","type":"`object`","description":"The details of the original price.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"Line truncated
|
||||
@@ -6,10 +6,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# Context
|
||||
|
||||
A shared context object that is used to share resources between the application and the module.
|
||||
A context used to share resources, such as transaction manager, between the application and the module.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TManager","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"TManager","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Context"/>
|
||||
|
||||
<ParameterTypes parameters={[{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Context"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A currency to create.
|
||||
|
||||
<ParameterTypes parameters={[{"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreateCurrencyDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The money amount to create.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreateMoneyAmountDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The price list to create.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"description","type":"`string`","description":"The price list's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string` \\| `Date`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]","description":"The prices associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"[CreatePriceListRules](pricing.CreatePriceListRules.mdx)","description":"The rules to be created and associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string` \\| `Date`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../enums/pricing.PriceListType.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"OVERRIDE","type":"`\"override\"`","description":"The price list's prices override original prices. This affects the calculated price of associated price sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SALE","type":"`\"sale\"`","description":"The price list's prices are used for a sale.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"title","type":"`string`","description":"The price list's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string` \\| `Date`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string` \\| `Date`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../enums/pricing.PriceListType.mdx)","description":"The price list's type.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"The price list's prices are used for a sale.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"The price list's prices override original prices. This affects the calculated price of associated price sets.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceListRules](pricing.CreatePriceListRules.mdx)","description":"The rules to be created and associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]","description":"The prices associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreatePriceListDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The price list rule to create.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"price_list","type":"`string` \\| [PriceListDTO](pricing.PriceListDTO.mdx)","description":"The ID of a price list or the details of an existing price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of a price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string` \\| [RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The ID of a rule type or the details of an existing rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"The ID of a rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"rule_type_id","type":"`string`","description":"The ID of a rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string` \\| [RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The ID of a rule type or the details of an existing rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of a price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`string` \\| [PriceListDTO](pricing.PriceListDTO.mdx)","description":"The ID of a price list or the details of an existing price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreatePriceListRuleDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A price rule to create.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"value","type":"`string`","description":"The value of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"`string` \\| [PriceSetDTO](pricing.PriceSetDTO.mdx)","description":"The ID or object of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount","type":"`string` \\| [PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)","description":"The ID or object of the associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount_id","type":"`string`","description":"The ID of the associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"The priority of the price rule in comparison to other applicable price rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string` \\| [RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The ID of the associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"The ID of the associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"value","type":"`string`","description":"The value of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"`string` \\| [PriceSetDTO](pricing.PriceSetDTO.mdx)","description":"The ID or object of the associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"The ID of the associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string` \\| [RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The ID of the associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"The priority of the price rule in comparison to other applicable price rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount_id","type":"`string`","description":"The ID of the associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount","type":"`string` \\| [PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)","description":"The ID or object of the associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreatePriceRuleDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A price set to create.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"prices","type":"[CreatePricesDTO](pricing.CreatePricesDTO.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules","type":"`object`[]","description":"The rules to associate with the price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"rule_attribute","type":"`string`","description":"the value of the rule's `rule_attribute` attribute.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"rules","type":"`object`[]","description":"The rules to associate with the price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"rule_attribute","type":"`string`","description":"the value of the rule's `rule_attribute` attribute.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"[CreatePricesDTO](pricing.CreatePricesDTO.mdx)[]","description":"The prices to create and add to this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="CreatePriceSetDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The price set money amount rule to create.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"price_set_money_amount","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`","description":"The ID of a rule type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the price set money amount rule.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"price_set_money_amount","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`","description":"The ID of a rule type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the price set money amount rule.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreatePriceSetMoneyAmountRulesDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The prices to create part of a price set.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreatePricesDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The rule type to create.
|
||||
|
||||
<ParameterTypes parameters={[{"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 the `calculatePrices` \nmethod to specify a rule for calculating the price.","optional":false,"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 the provided context. \nThe higher the value, the higher the priority of the rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"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 the `calculatePrices` \nmethod to specify a rule for calculating the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the rule type.","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 the provided context. \nThe higher the value, the higher the priority of the rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CreateRuleTypeDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A currency's data.
|
||||
|
||||
<ParameterTypes parameters={[{"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":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"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":"name","type":"`string`","description":"The name of the currency.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CurrencyDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on a currency.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterableCurrencyProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on a money amount.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterableMoneyAmountProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on price lists.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceListProps](pricing.FilterablePriceListProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListProps](pricing.FilterablePriceListProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceListProps](pricing.FilterablePriceListProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListProps](pricing.FilterablePriceListProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`string`[]","description":"The end dates to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price lists by","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`[]","description":"The number of rules to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`string`[]","description":"The start dates to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)[]","description":"The statuses to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceListProps](pricing.FilterablePriceListProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListProps](pricing.FilterablePriceListProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceListProps](pricing.FilterablePriceListProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListProps](pricing.FilterablePriceListProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price lists by","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`string`[]","description":"The start dates to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`string`[]","description":"The end dates to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)[]","description":"The statuses to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules_count","type":"`number`[]","description":"The number of rules to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterablePriceListProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on price list rules.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price list rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`[]","description":"Filter price list rules by the ID of their associated price lists.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`[]","description":"Filter price list rules by the ID of their associated rule types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`[]","description":"The values to filter price list rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price list rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`[]","description":"The values to filter price list rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`[]","description":"Filter price list rules by the ID of their associated rule types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`[]","description":"Filter price list rules by the ID of their associated price lists.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterablePriceListRuleProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on price rules.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`[]","description":"The names to filter price rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price rule's associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price rule's associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`[]","description":"The names to filter price rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price rule's associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price rule's associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterablePriceRuleProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on price set money amounts.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the price set money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`[]","description":"The IDs to filter the price set money amount's associated price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price set money amount's associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter the price set money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price set money amount's associated price set.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`[]","description":"The IDs to filter the price set money amount's associated price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterablePriceSetMoneyAmountProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on price set money amount rules.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The ID to filter price set money amount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`[]","description":"The value to filter price set money amount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The ID to filter price set money amount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`[]","description":"The value to filter price set money amount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterablePriceSetMoneyAmountRulesProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on price sets.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amounts","type":"[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amounts","type":"[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="FilterablePriceSetProps"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on rule types.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter rule types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`[]","description":"The names to filter rule types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_attribute","type":"`string`[]","description":"The rule attributes to filter rule types by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"$and","type":"([FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)<[FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter rule types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`[]","description":"The names to filter rule types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_attribute","type":"`string`[]","description":"The rule attributes to filter rule types by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FilterableRuleTypeProps"/>
|
||||
@@ -11,6 +11,6 @@ which provides correct typing of field names in its properties.
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"Entity","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"Entity","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FindConfig"/>
|
||||
|
||||
<ParameterTypes parameters={[{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="FindConfig"/>
|
||||
+51
-51
@@ -14,61 +14,61 @@ This section of the documentation provides a reference to the `IPricingModuleSer
|
||||
|
||||
## Methods
|
||||
|
||||
- [addPriceListPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx)
|
||||
- [addPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx)
|
||||
- [addRules](../IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx)
|
||||
- [calculatePrices](../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx)
|
||||
- [create](../IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx)
|
||||
- [createCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx)
|
||||
- [createMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx)
|
||||
- [createPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx)
|
||||
- [createPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx)
|
||||
- [createPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx)
|
||||
- [createPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
|
||||
- [createRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx)
|
||||
- [delete](../IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx)
|
||||
- [deleteCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx)
|
||||
- [deleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx)
|
||||
- [deletePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx)
|
||||
- [deletePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx)
|
||||
- [deletePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx)
|
||||
- [deletePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
|
||||
- [deleteRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx)
|
||||
- [retrieve](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx)
|
||||
- [list](../IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx)
|
||||
- [listAndCount](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx)
|
||||
- [listAndCountCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx)
|
||||
- [listAndCountMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx)
|
||||
- [listAndCountPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx)
|
||||
- [listAndCountPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx)
|
||||
- [listAndCountPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx)
|
||||
- [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
|
||||
- [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
|
||||
- [listAndCountRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx)
|
||||
- [listCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx)
|
||||
- [listMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx)
|
||||
- [listPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx)
|
||||
- [listPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx)
|
||||
- [listPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx)
|
||||
- [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
|
||||
- [listPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx)
|
||||
- [listRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx)
|
||||
- [removePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx)
|
||||
- [create](../IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx)
|
||||
- [removeRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx)
|
||||
- [restoreDeletedMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.restoreDeletedMoneyAmounts.mdx)
|
||||
- [retrieve](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx)
|
||||
- [retrieveCurrency](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx)
|
||||
- [delete](../IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx)
|
||||
- [addPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx)
|
||||
- [addRules](../IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx)
|
||||
- [retrieveMoneyAmount](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx)
|
||||
- [retrievePriceList](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx)
|
||||
- [retrievePriceListRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx)
|
||||
- [retrievePriceRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx)
|
||||
- [retrievePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
|
||||
- [retrieveRuleType](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx)
|
||||
- [setPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx)
|
||||
- [softDeleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.softDeleteMoneyAmounts.mdx)
|
||||
- [updateCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx)
|
||||
- [listMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx)
|
||||
- [listAndCountMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx)
|
||||
- [createMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx)
|
||||
- [updateMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx)
|
||||
- [updatePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx)
|
||||
- [updatePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx)
|
||||
- [updatePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx)
|
||||
- [updatePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
|
||||
- [deleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx)
|
||||
- [softDeleteMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.softDeleteMoneyAmounts.mdx)
|
||||
- [restoreDeletedMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.restoreDeletedMoneyAmounts.mdx)
|
||||
- [retrieveCurrency](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx)
|
||||
- [listCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx)
|
||||
- [listAndCountCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx)
|
||||
- [createCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx)
|
||||
- [updateCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx)
|
||||
- [deleteCurrencies](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx)
|
||||
- [retrieveRuleType](../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx)
|
||||
- [listRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx)
|
||||
- [listAndCountRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx)
|
||||
- [createRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx)
|
||||
- [updateRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx)
|
||||
- [deleteRuleTypes](../IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx)
|
||||
- [retrievePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
|
||||
- [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
|
||||
- [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
|
||||
- [listPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx)
|
||||
- [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
|
||||
- [createPriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
|
||||
- [updatePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
|
||||
- [deletePriceSetMoneyAmountRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
|
||||
- [retrievePriceRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx)
|
||||
- [listPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx)
|
||||
- [listAndCountPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx)
|
||||
- [createPriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx)
|
||||
- [updatePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx)
|
||||
- [deletePriceRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx)
|
||||
- [retrievePriceList](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx)
|
||||
- [listPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx)
|
||||
- [listAndCountPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx)
|
||||
- [createPriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx)
|
||||
- [updatePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx)
|
||||
- [deletePriceLists](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx)
|
||||
- [retrievePriceListRule](../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx)
|
||||
- [listPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx)
|
||||
- [listAndCountPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx)
|
||||
- [createPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx)
|
||||
- [updatePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx)
|
||||
- [deletePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx)
|
||||
- [addPriceListPrices](../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx)
|
||||
- [setPriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx)
|
||||
- [removePriceListRules](../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx)
|
||||
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# JoinerServiceConfig
|
||||
|
||||
<ParameterTypes parameters={[{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](pricing.JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](pricing.JoinerServiceConfigAlias.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"relationship","type":"[JoinerRelationship](../types/pricing.JoinerRelationship.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[JoinerRelationship](../types/pricing.JoinerRelationship.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} />
|
||||
<ParameterTypes parameters={[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"[JoinerServiceConfigAlias](pricing.JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](pricing.JoinerServiceConfigAlias.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[JoinerRelationship](../types/pricing.JoinerRelationship.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[JoinerRelationship](../types/pricing.JoinerRelationship.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="JoinerServiceConfig"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
# JoinerServiceConfigAlias
|
||||
|
||||
<ParameterTypes parameters={[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"name","type":"`string` \\| `string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="JoinerServiceConfigAlias"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A money amount's data. A money amount represents a price.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"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":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"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.PriceLine truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code 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":"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":"name","type":"`string`","description":"The name of the currency.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"amount","type":"`number`","description":"The price of this money amount.","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":"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":"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":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price set money amount.","optional":true,"defaultValue":"","expandable":false,"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":"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":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","expandable":false,"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":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","descLine truncated
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A price list's details.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"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":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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":"price_list_rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"deLine truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price set money amount.","optional":true,"defaultValue":"","expandable":false,"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":"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":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","expandable":false,"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":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The associated rule types.","optional":true,"defaultValue":"","expLine truncated
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The prices associated with a price list.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"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":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceSetPriceRules](pricing.CreatePriceSetPriceRules.mdx)","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="PriceListPriceDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The price list rule's details.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"[PriceListDTO](pricing.PriceListDTO.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"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":"price_list_rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"[PriceListDTO](pricing.PriceListDTO.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_type","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The associated rule type.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`string`","description":"The value of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rule_values","type":"[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]","description":"The associated rule values.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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,"defaultLine truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The associated rule type.","optional":false,"defaultValue":"","expandable":true,"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":[]},{"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":"price_list","type":"[PriceListDTO](pricing.PriceListDTO.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price set money amount.","optional":true,"defaultValue":"","expandable":false,"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_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_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"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":"money_amount","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)","description":"The money amount associated with the price set money amLine truncated
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The price list rule value's details.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list rule value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rule","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)","description":"The associated price list rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"[PriceListDTO](pricing.PriceListDTO.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The associated rule types.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_type","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The associated rule type.","optional":false,"defaultValue":"","expandable":true,"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":[]}]},{"name":"value","type":"`string`","description":"The value of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rule_values","type":"[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]","description":"The associated rule values.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rule","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)","description":"The associated price list rule.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`string`","description":"The rule's value.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"value","type":"`string`","description":"The rule's value.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list rule value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The rule's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rule","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)","description":"The associated price list rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The associated rule type.","optional":false,"defaultValue":"","expandable":true,"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":[]},{"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":"price_list","type":"[PriceListDTO](pricing.PriceListDTO.mdx)","description":"The associated price list.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The associated rule types.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"price_list_rule_values","type":"[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]","description":"The associated rule values.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list rule value's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The rule's value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_rule","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)","description":"The associated price list rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]}]}]} sectionTitle="PriceListRuleValueDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A price rule's data.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"When the price\\_rule was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_rule was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"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](pricing.PriceSetDTO.mdx)","description":"The associated price set.","optional":false,"defaultValue":"","expandable":true,"children":[{"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":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"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":"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":[]}]}]},{"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](pricing.RuleTypeDTO.mdx)","description":"The associated rule type.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"default_priority","type":"`number`","description":"The priority of the rule type. This is useful when calculating the price of a price Line truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](pricing.PriceSetDTO.mdx)","description":"The associated price set.","optional":false,"defaultValue":"","expandable":true,"children":[{"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":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code 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":"amount","type":"`number`","description":"The price of this money amount.","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":"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":"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":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"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":[]},{"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":"rule_type_id","type":"`string`","description":"The ID of the associated rule type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)","description":"The associated rule type.","optional":false,"defaultValue":"","expandable":true,"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":[]},{"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 priorLine truncated
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
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":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"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":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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 usefulLine truncated
|
||||
<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":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code 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":"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":"name","type":"`string`","description":"The name of the currency.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"amount","type":"`number`","description":"The price of this money amount.","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":"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":"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":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price set money amount.","optional":true,"defaultValue":"","expandable":false,"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_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_set_id","type":"`string`","description":"The ID of the associated price set.","optional":true,"defaultValue":"","expandable":false,"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":"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":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the rule type.","optional":false,"defaultValue":"Line truncated
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A price set money amount's data.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"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":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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 tLine truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price set money amount.","optional":true,"defaultValue":"","expandable":false,"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":"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":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code 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":"amount","type":"`number`","description":"The price of this money amount.","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":"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":"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":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"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":[]},{"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":"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":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaulLine truncated
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A price set money amount rule's data.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)","description":"The associated price set money amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","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":"created_at","type":"`Date`","description":"When the money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the money\\_amount was updated.","optional":false,"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":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"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":"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":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The associated rule types.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceLisLine truncated
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)","description":"The associated price set money amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of a price set money amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"When the price\\_set\\_money\\_amount was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"When the price\\_set\\_money\\_amount was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the price set money amount.","optional":true,"defaultValue":"","expandable":false,"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":"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":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","expandable":false,"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":"id","type":"`string`","description":"The price list's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with this price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amounts","type":"[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]","description":"The associated price set money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"money_amounts","type":"[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]","description":"The associated money amounts.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_types","type":"[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]","description":"The associated rule types.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]","description":"The price set's rules.","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":"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":"id","type":"`string`","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"[PriceSetDTO](pricing.PriceSetDTO.mdx)","description":"The associated price set.","optional":false,"dLine truncated
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The context to calculate prices. For example, you can specify the currency code to calculate prices in.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"context","type":"`Record<string, string \\| number>`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"context","type":"`Record<string, string \\| number>`","description":"an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="PricingContext"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
Filters to apply on prices.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`[]","description":"IDs to filter prices.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`[]","description":"IDs to filter prices.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="PricingFilters"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The rules to remove from a price list.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"The ID of the price list to remove rules from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`string`[]","description":"The rules to remove from the price list. Each item being a rule type's `rule_attribute`.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"The ID of the price list to remove rules from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`string`[]","description":"The rules to remove from the price list. Each item being a rule type's `rule_attribute`.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RemovePriceListRulesDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The rules to remove from a price set.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`string`[]","description":"The rules to remove. Each string is the `rule_attribute` of a rule to remove.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`string`[]","description":"The rules to remove. Each string is the `rule_attribute` of a rule to remove.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RemovePriceSetRulesDTO"/>
|
||||
@@ -10,6 +10,6 @@ An object that is used to specify an entity's related entities that should be re
|
||||
|
||||
## Type parameters
|
||||
|
||||
<ParameterTypes parameters={[{"name":"TReturnableLinkableKeys","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"TReturnableLinkableKeys","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RestoreReturn"/>
|
||||
|
||||
<ParameterTypes parameters={[{"name":"returnLinkableKeys","type":"TReturnableLinkableKeys[]","description":"An array of strings, each being the ID attribute names of the entity's relations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"returnLinkableKeys","type":"TReturnableLinkableKeys[]","description":"An array of strings, each being the ID attribute names of the entity's relations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="RestoreReturn"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
A rule type's data.
|
||||
|
||||
<ParameterTypes parameters={[{"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":[]}]} />
|
||||
<ParameterTypes parameters={[{"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":[]},{"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":[]}]} sectionTitle="RuleTypeDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The rules to add to a price list.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"The ID of the price list to add rules to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`Record<string, string \\| string[]>`","description":"The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value\nis the value(s) of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"priceListId","type":"`string`","description":"The ID of the price list to add rules to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"`Record<string, string \\| string[]>`","description":"The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value\nis the value(s) of the rule.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="SetPriceListRulesDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The data to update in a currency. The `code` is used to identify which currency to update.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency to update.","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":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The code of the currency to update.","optional":false,"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":"name","type":"`string`","description":"The name of the currency.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateCurrencyDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The data to update in a money amount. The `id` is used to identify which money amount to update.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the money amount to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The code of the currency to associate with the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the money amount to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The code of the currency to associate with the money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The price of this money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateMoneyAmountDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The attributes to update in a price list.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price list to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string` \\| `Date`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceListRules](pricing.CreatePriceListRules.mdx)","description":"The rules to be created and associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string` \\| `Date`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price list to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The price list's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`null` \\| `string` \\| `Date`","description":"The price list is enabled starting from this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `string` \\| `Date`","description":"The price list expires after this date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../enums/pricing.PriceListStatus.mdx)","description":"The price list's status.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is enabled and its prices can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is disabled, meaning its prices can't be used yet.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rules_count","type":"`number`","description":"The number of rules associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[CreatePriceListRules](pricing.CreatePriceListRules.mdx)","description":"The rules to be created and associated with the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdatePriceListDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The attributes to update in a price list rule.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price list rule to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`string`","description":"The ID of a price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of a price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`","description":"The ID of a rule type or the details of an existing rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"The ID of a rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price list rule to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of a price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"The ID of a rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`string`","description":"The ID of a price list to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`","description":"The ID of a rule type or the details of an existing rule type to be associated with the price list rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdatePriceListRuleDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The data to update in a price rule. The `id` is used to identify which money amount to update.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of the associated price list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount_id","type":"`string`","description":"The ID of the associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"The priority of the price rule in comparison to other applicable price rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the price rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the price rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`number`","description":"The priority of the price rule in comparison to other applicable price rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount_id","type":"`string`","description":"The ID of the associated price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of the associated price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdatePriceRuleDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The data to update in a price set. The `id` is used to identify which price set to update.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"A string indicating the ID of the price set to update.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"A string indicating the ID of the price set to update.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdatePriceSetDTO"/>
|
||||
+1
-1
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The data to update in a price set money amount rule. The `id` is used to identify which money amount to update.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set money amount rule to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount","type":"`string`","description":"The ID of a price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`","description":"The ID of a rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the price set money amount rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the price set money amount rule to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set_money_amount","type":"`string`","description":"The ID of a price set money amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_type","type":"`string`","description":"The ID of a rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value of the price set money amount rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdatePriceSetMoneyAmountRulesDTO"/>
|
||||
@@ -8,4 +8,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
|
||||
The data to update in a rule type. The `id` is used to identify which price set to update.
|
||||
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the rule type to update.","optional":false,"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 the provided context. The higher the value, the higher the priority of the rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The display name of the rule type.","optional":true,"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 the `calculatePrices` method to specify a rule for calculating the price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
|
||||
<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the rule type to update.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The display name of the rule type.","optional":true,"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 the `calculatePrices` method to specify a rule for calculating the price.","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 the provided context. The higher the value, the higher the priority of the rule type.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="UpdateRuleTypeDTO"/>
|
||||
Reference in new issue
Block a user