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

displayed_sidebar
displayed_sidebar
pricingReference

PriceRuleDTO

An object that represents 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:22


is_dynamic

is_dynamic: boolean

A boolean indicating whether the price rule is dynamic.

Defined in

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


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


price_set

price_set: PriceSetDTO

An object of type PriceSetDTO that holds the data of the associated price set. It may only be available if the relation price_set is expanded.

Defined in

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


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


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


priority

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


rule_type

rule_type: RuleTypeDTO

An object of type RuleTypeDTO that holds the data of the associated rule type. It may only be available if the relation rule_type is expanded.

Defined in

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


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


value

value: string

A string indicating the value of the price rule.

Defined in

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