chore(docs): Generated References (automated) (#14182)
Generated the following references: - `api_key_models` - `auth_models` - `cart_models` - `core_flows` - `currency_models` - `customer_models` - `file` - `file_service` - `fulfillment` - `fulfillment_models` - `helper_steps` - `inventory_next_models` - `js_sdk` - `module_events` - `modules` - `notification` - `notification_service` - `order` - `order_models` - `payment` - `payment_models` - `pricing_models` - `product_models` - `promotion` - `promotion_models` - `region_models` - `sales_channel_models` - `stock_location_next_models` - `store_models` - `tax_models` - `types` - `user_models` - `utils` - `workflows` --- > [!NOTE] > Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values. > > - **Docs Generation**: > - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples. > - **Fulfillment Workflows/Steps**: > - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`). > - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag. > - Refreshed example snippets and sample values. > - **Notification Step** (`sendNotificationsStep`): > - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional. > - Output includes `provider_data` and `attachments` fields. > - **Order Steps/Workflows**: > - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions. > - Example payloads adjusted (IDs, currencies, amounts). > - **Meta**: > - Updated `<SourceCodeLink>` URLs to new commit hashes throughout. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> 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:
983 files changed
+427349
-403173
No files matched your search
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the ApplicationMethod data model. It belongs to the Promotion Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/application-method.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/application-method.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"BelongsTo<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotion.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"childLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"EnumProperty<typeof [ApplicationMethodTargetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodTargetType/page.mdx)>","description":"Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"BelongsTo<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotion.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](./page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`NumberProperty`","description":"The limit of the promotion\n\n@since v2.12.0","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaignLine truncated
|
||||
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Campaign data model. It belongs to the Promotion Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/campaign.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/campaign.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign","type":"BelongsTo<[Campaign](./page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defauLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"limit","type":"`NumberProperty`","description":"The limit of the promotion\n\n@since v2.12.0","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"campaign","type":"BelongsTo<[Campaign](./page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"Line truncated
|
||||
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the CampaignBudget data model. It belongs to the Promotion Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/campaign-budget.ts#L5" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/campaign-budget.ts#L5" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [CampaignBudgetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)>","description":"The type of the campaign budget","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date that the campaign ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"HasOne<[CampaignBudget](./page.mdx)>","description":"The associated budget.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [CampaignBudgetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)>","description":"The type of the campaign budget","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usaLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [CampaignBudgetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)>","description":"The type of the campaign budget","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"limit","type":"`NumberProperty`","description":"The limit of the promotion\n\n@since v2.12.0","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.\n\n@since v2.12.0","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"}]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date that the campaign ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"HasOne<[CampaignBudget](./page.mdx)>","description":"The associated budget.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"ThLine truncated
|
||||
+1
-1
@@ -16,6 +16,6 @@ This is available starting from [Medusa v2.11.0](https://github.com/medusajs/med
|
||||
|
||||
:::
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/campaign-budget-usage.ts#L7" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/campaign-budget-usage.ts#L7" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget usage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute_value","type":"`TextProperty`","description":"The attribute value of the campaign budget usage","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"The used of the campaign budget usage","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"BelongsTo<[CampaignBudget](../promotion_models.CampaignBudget/page.mdx)>","description":"The associated budget.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [CampaignBudgetType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.CampaignBudgetType/page.mdx)>","description":"The type of the campaign budget","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"How much of the budget has been used. if the `limit` is `spend`, this property holds the total amount discounted so far. if the `limit` is `usage`, it holds the number of times the campaign's promotions have been used so far.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the campaign","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"`TextProperty`","description":"The campaign's identifier, such as a Google Tag ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotions","type":"HasMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the campaign","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`DateTimeProperty`","description":"The date that the campaign starts.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`DateTimeProperty`","description":"The date that the campaign ends.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"HasOne<[CampaignBudget](../promotion_models.CampaignBudget/page.mdx)>","description":"The associated budget.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"usages","type":"HasMany<[CampaignBudgetUsage](./page.mdx)>","description":"The associated usages.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the campaign budget usage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute_value","type":"`TextProperty`","description":"The attribute value of the campaign budget usage","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`BigNumberProperty`","description":"The used of the campaign budget usage","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"BelongsTo<[CampaignBudget](../promotion_models.CampaignBudget/page.mdx)>","description":"The associated budget.","optional":false,"defaultValue":"","expandable":true,"children":[]}],"since":"2.11.0"},{"name":"currency_code","type":"`TextProperty`","description":"The currency code of the campaign budget.\n\n@example usd","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`BigNumberProperty`","description":"The limit of the campaign budget","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the campaign budget","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"2.11.0"}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CampaignBudgetUsage"/>
|
||||
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Promotion data model. It belongs to the Promotion Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/promotion.ts#L6" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/promotion.ts#L6" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](./page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated applicatioLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](./page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"childLine truncated
|
||||
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PromotionRule data model. It belongs to the Promotion Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/promotion-rule.ts#L6" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/promotion-rule.ts#L6" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](./page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](./page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optionalLine truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](./page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](../promotion_models.PromotionRuleValue/page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"method_buy_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method buy rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`TextProperty`","description":"The description of the promotion rule","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](./page.mdx)>","description":"The associated rLine truncated
|
||||
+2
-2
@@ -10,6 +10,6 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the PromotionRuleValue data model. It belongs to the Promotion Module.
|
||||
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/147ce2fdc35366e591f552404ec949f6a5b92a11/packages/modules/promotion/src/models/promotion-rule-value.ts#L4" />
|
||||
<SourceCodeLink link="https://github.com/medusajs/medusa/blob/e4513fab88f5ba7d5c078d3e251e04b104268a56/packages/modules/promotion/src/models/promotion-rule-value.ts#L4" />
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](./page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"EnumProperty<typeof [ApplicationMethodType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.ApplicationMethodType/page.mdx)>","description":"The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type"Line truncated
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`TextProperty`","description":"The attribute of the promotion rule.\n\n@example customer\\_group\\_id","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"EnumProperty<typeof [PromotionRuleOperator](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionRuleOperator/page.mdx)>","description":"The operator of the promotion rule.\n\n@example in","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"HasMany<[PromotionRuleValue](./page.mdx)>","description":"The associated values.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`TextProperty`","description":"The value of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion_rule","type":"BelongsTo<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated promotion rule.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"promotions","type":"ManyToMany<[Promotion](../promotion_models.Promotion/page.mdx)>","description":"The associated promotions.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`TextProperty`","description":"The code of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"`BooleanProperty`","description":"Whether the promotion is applied automatic. If disabled, the customer must enter the code during checkout.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"`BooleanProperty`","description":"Whether the promotion is tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"`NumberProperty`","description":"The used of the promotion\n\n@since v2.12.0","optional":false,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"type","type":"EnumProperty<typeof [PromotionType](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionType/page.mdx)>","description":"The type of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"EnumProperty<typeof [PromotionStatus](../../../utils/PromotionUtils/enums/utils.PromotionUtils.PromotionStatus/page.mdx)>","description":"The status of the promotion","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"ManyToMany<[PromotionRule](../promotion_models.PromotionRule/page.mdx)>","description":"The associated rules.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"limit","type":"`NumberProperty`","description":"The limit of the promotion\n\n@since v2.12.0","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"},{"name":"campaign","type":"BelongsTo<[Campaign](../promotion_models.Campaign/page.mdx)>","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"application_method","type":"HasOne<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated application method.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.\n\n@since v2.12.0","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"v2.12.0"}]},{"name":"method_target_rules","type":"ManyToMany<[ApplicationMethod](../promotion_models.ApplicationMethod/page.mdx)>","description":"The associated method target rules.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PLine truncated
|
||||
Reference in new issue
Block a user