docs: generate pricing module reference (#5349)

* docs: generate pricing module reference

* added notes about new configurations
This commit is contained in:
Shahed Nasser
2023-10-11 14:08:19 +03:00
committed by GitHub
parent 9c1c19f409
commit f0af8ecc89
110 changed files with 7170 additions and 146 deletions

View File

@@ -0,0 +1,91 @@
---
displayed_sidebar: pricingReference
---
# UpdatePriceRuleDTO
An object used to specify the necessary data to update a price rule.
## Properties
### id
**id**: `string`
A string indicating the ID of the price rule to update.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:75](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L75)
___
### price\_list\_id
`Optional` **price\_list\_id**: `string`
A string indicating the ID of the associated price list.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:88](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L88)
___
### price\_set\_id
`Optional` **price\_set\_id**: `string`
A string indicating the ID of the associated price set.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:76](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L76)
___
### price\_set\_money\_amount\_id
`Optional` **price\_set\_money\_amount\_id**: `string`
A string indicating the ID of the associated price set money amount.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:87](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L87)
___
### priority
`Optional` **priority**: `number`
A number indicating the priority of the price rule in comparison to other applicable price rules.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:86](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L86)
___
### rule\_type\_id
`Optional` **rule\_type\_id**: `string`
A string indicating the ID of the associated rule type.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:77](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L77)
___
### value
`Optional` **value**: `string`
A string indicating the value of the price rule.
#### Defined in
[packages/types/src/pricing/common/price-rule.ts:85](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L85)