Files
medusa-store/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.md
Shahed Nasser f0af8ecc89 docs: generate pricing module reference (#5349)
* docs: generate pricing module reference

* added notes about new configurations
2023-10-11 14:08:19 +03:00

3.3 KiB

displayed_sidebar
displayed_sidebar
pricingReference

CreatePricesDTO

An object used to pass prices data when creating a price set.

Hierarchy

Properties

amount

Optional amount: number

A number indicating the amount of this money amount.

Inherited from

CreateMoneyAmountDTO.amount

Defined in

packages/types/src/pricing/common/money-amount.ts:41


currency

Optional currency: CreateCurrencyDTO

An object of type CurrencyDTO that holds the details of the money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the relations array of the find-configuration options.

Inherited from

CreateMoneyAmountDTO.currency

Defined in

packages/types/src/pricing/common/money-amount.ts:40


currency_code

currency_code: string

A string that indicates the currency code of this money amount.

Inherited from

CreateMoneyAmountDTO.currency_code

Defined in

packages/types/src/pricing/common/money-amount.ts:39


id

Optional id: string

A string that indicates the ID of the money amount.

Inherited from

CreateMoneyAmountDTO.id

Defined in

packages/types/src/pricing/common/money-amount.ts:38


max_quantity

Optional max_quantity: number

A number that indicates the maximum quantity required to be purchased for this money amount to be applied.

Inherited from

CreateMoneyAmountDTO.max_quantity

Defined in

packages/types/src/pricing/common/money-amount.ts:43


min_quantity

Optional min_quantity: number

A number that indicates the minimum quantity required to be purchased for this money amount to be applied.

Inherited from

CreateMoneyAmountDTO.min_quantity

Defined in

packages/types/src/pricing/common/money-amount.ts:42


rules

rules: Record<string, string>

An object whose keys are rule types' rule_attribute attribute, and values are the value of that rule associated with this price.

Defined in

packages/types/src/pricing/common/price-set.ts:93