Files
medusa-store/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.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

2.4 KiB

displayed_sidebar
displayed_sidebar
pricingReference

CreatePriceRuleDTO

An object used to specify the necessary data to create a price rule.

Properties

id

id: string

A string indicating the ID of the price rule.

Defined in

packages/types/src/pricing/common/price-rule.ts:50


is_dynamic

Optional is_dynamic: boolean

A boolean indicating whether the price rule is dynamic.

Defined in

packages/types/src/pricing/common/price-rule.ts:53


price_list_id

price_list_id: string

A string indicating the ID of the associated price list.

Defined in

packages/types/src/pricing/common/price-rule.ts:57


price_set_id

price_set_id: string

A string indicating the ID of the associated price set.

Defined in

packages/types/src/pricing/common/price-rule.ts:51


price_set_money_amount_id

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:56


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:55


rule_type_id

rule_type_id: string

A string indicating the ID of the associated rule type.

Defined in

packages/types/src/pricing/common/price-rule.ts:52


value

value: string

A string indicating the value of the price rule.

Defined in

packages/types/src/pricing/common/price-rule.ts:54