chore(docs): Generated References (automated) (#12460)
Generated the following references: - `_index.mdx` - `api_key` - `api_key_models` - `auth` - `auth_models` - `auth_provider` - `cart` - `cart_models` - `core_flows` - `currency` - `currency_models` - `customer` - `customer_models` - `events` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `fulfillment_provider` - `inventory_next` - `inventory_next_models` - `js_sdk` - `locking` - `medusa` - `module_events` - `modules` - `modules_sdk` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `payment_provider` - `pricing` - `pricing_models` - `product` - `product_models` - `promotion` - `promotion_models` - `region` - `region_models` - `sales_channel` - `sales_channel_models` - `stock_location_next` - `stock_location_next_models` - `store` - `store_models` - `tax` - `tax_models` - `tax_provider` - `types` - `user` - `user_models` - `utils` - `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:
1978 files changed
+332243
-279592
No files matched your search
@@ -10,4 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Price data model. It belongs to the Pricing Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/pricing/src/models/price.ts#L6" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)>","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)>","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](./page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_rules","type":"HasMany<[PriceRule](../pricing_models.PriceRule/page.mdx)>","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`NumberProperty`","description":"The minimum quantity that must be available in the cart for the price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`NumberProperty`","description":"The maximum quantity allowed to be available in the cart for the price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceList`.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"price_list_rules","type":"HasMany<[PriceListRule](../pricing_models.PriceListRule/page.mdx)>","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price list rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceList`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the price list rule. For example, `reg_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"Line truncated
|
||||
+2
@@ -10,4 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PriceList data model. It belongs to the Pricing Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/pricing/src/models/price-list.ts#L9" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)>","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)>","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo<[PriceList](./page.mdx)>","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)>","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)>","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"HasMany<[PriceListRule](../pricing_models.PriceListRule/page.mdx)>","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"HasMany<[PriceRule](../pricing_models.PriceRule/page.mdx)>","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)>","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priorLine truncated
|
||||
+2
@@ -10,4 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PriceListRule data model. It belongs to the Pricing Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/pricing/src/models/price-list-rule.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price list rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceList`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)>","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)>","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_rules","type":"HasMany<[PriceRule](../pricing_models.PriceRule/page.mdx)>","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`NumberProperty`","description":"The minimum quantity that must be available in the cart for the price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`NumberProperty`","description":"The maximum quantity allowed to be available in the cart for the price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceList`.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"price_list_rules","type":"HasMany<[PriceListRule](./page.mdx)>","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price list rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceList`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"value","type":"`JSONProperty`","description":"The value of the price list rule. For example, `reg_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
|
||||
+2
@@ -10,4 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PricePreference data model. It belongs to the Pricing Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/pricing/src/models/price-preference.ts#L3" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price preference. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether prices matching this preference include taxes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price preference. For example, `reg_123`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PricePreference"/>
|
||||
+2
@@ -10,4 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PriceRule data model. It belongs to the Pricing Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/pricing/src/models/price-rule.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)>","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priority of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"BelongsTo<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)>","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)>","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"HasMany<[PriceListRule](../pricing_models.PriceListRule/page.mdx)>","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"HasMany<[PriceRule](./page.mdx)>","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)>","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priority of the price rule.","opLine truncated
|
||||
+2
@@ -10,4 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PriceSet data model. It belongs to the Pricing Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e09fd61a8f649959a6c0819c1d867abf05ae0dc4/packages/modules/pricing/src/models/price-set.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the price. For example, `usd`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`BigNumberProperty`","description":"The amount of the price.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_set","type":"BelongsTo<[PriceList](../pricing_models.PriceList/page.mdx)>","description":"The associated `PriceSet`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`TextProperty`","description":"The title of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PriceListStatus](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListStatus/page.mdx)>","description":"The status of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PriceListType](../../../utils/PricingUtils/enums/utils.PricingUtils.PriceListType/page.mdx)>","description":"The type of the price list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"HasMany<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_rules","type":"HasMany<[PriceListRule](../pricing_models.PriceListRule/page.mdx)>","description":"The associated `PriceListRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date the price list starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date the price list ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules_count","type":"`NumberProperty`","description":"The total number of rules of the price list.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_rules","type":"HasMany<[PriceRule](../pricing_models.PriceRule/page.mdx)>","description":"The associated `PriceRule` records.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the price rule. For example, `region_id`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the price rule. For example, `reg_123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PricingRuleOperator](../../../utils/PricingUtils/enums/utils.PricingUtils.PricingRuleOperator/page.mdx)>","description":"The operator of the price rule. For example, `eq`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"priority","type":"`NumberProperty`","description":"The priority of the price rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"BelongsTo<[Price](../pricing_models.Price/page.mdx)>","description":"The associated `Price`.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"title","type":"`TextProperty`","description":"The title of the price","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`NumberProperty`","description":"The minimum quantity that must be available in the cart for the price to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`NumberProperty`","description":"The maximum quantity allowed to be available in the cart for the price to be applied.","optional":true,Line truncated
|
||||
Reference in new issue
Block a user