import { TypeList } from "docs-ui"

PromotionDTO

The promotion details.

<TypeList types={[{"name":"id","type":"string","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"PromotionTypeValues","description":"The type of the promotion:\n\n- standard indicates that a promotion is a standard one applied with conditions.\n- buyget indicates that a promotion is a "Buy X get Y" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"PromotionStatusValues","description":"The status of the promotion:\n\n- active promotion is available for user to consume\n- inactive promotion is no longer available to the user\n- draft promotion is currently being prepared","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"boolean","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Whether the promotion is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"null \| number","description":"The maximum number of times this promotion can be used across all orders.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"number","description":"The number of times this promotion has been used in completed orders.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"ApplicationMethodDTO","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the application method.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"ApplicationMethodTypeValues","description":"The type of the application method indicating how\nthe associated promotion is applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"target_type","type":"ApplicationMethodTargetTypeValues","description":"The target type of the application method indicating\nwhether the associated promotion is applied to the cart's items,\nshipping methods, or the whole order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"ApplicationMethodAllocationValues","description":"The allocation value that indicates whether the associated promotion\nis applied on each item in a cart or split between the items in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"number","description":"The discounted amount applied by the associated promotion based on the type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"string","description":"The currency code of the application method","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"null \| number","description":"The max quantity allowed in the cart for the associated promotion to be applied.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"buy_rules_min_quantity","type":"null \| number","description":"The minimum quantity required for a buyget promotion to be applied.\nFor example, if the promotion is a "Buy 2 shirts get 1 free", the\nvalue of this attribute is 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"apply_to_quantity","type":"null \| number","description":"The quantity that results from matching the buyget promotion's condition.\nFor example, if the promotion is a "Buy 2 shirts get 1 free", the value\nof this attribute is 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"promotion","type":"string \| PromotionDTO","description":"The promotion of the application method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"PromotionTypeValues","description":"The type of the promotion:\n\n- standard indicates that a promotion is a standard one applied with conditions.\n- buyget indicates that a promotion is a "Buy X get Y" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"PromotionStatusValues","description":"The status of the promotion:\n\n- active promotion is available for user to consume\n- inactive promotion is no longer available to the user\n- draft promotion is currently being prepared","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"boolean","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Whether the promotion is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"null \| number","description":"The maximum number of times this promotion can be used across all orders.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"number","description":"The number of times this promotion has been used in completed orders.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"ApplicationMethodDTO","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"PromotionRuleDTO[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"null \| string","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"CampaignDTO","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"target_rules","type":"PromotionRuleDTO[]","description":"The target rules of the application method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"PromotionRuleValueDTO[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"null \| string","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"string","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"PromotionRuleOperatorValues","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"buy_rules","type":"PromotionRuleDTO[]","description":"The buy rules of the application method.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"PromotionRuleValueDTO[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"null \| string","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"string","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"PromotionRuleOperatorValues","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"rules","type":"PromotionRuleDTO[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"PromotionRuleValueDTO[]","description":"The values of the promotion rule.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the promotion rule value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"string","description":"The value of the promotion rule value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"null \| string","description":"The description of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"string","description":"The attribute of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"PromotionRuleOperatorValues","description":"The operator of the promotion rule.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"campaign_id","type":"null \| string","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"CampaignDTO","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the campaign.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"string","description":"The name of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"string","description":"The description of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_identifier","type":"string","description":"The campaign identifier of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"Date","description":"The start date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"Date","description":"The end date of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"budget","type":"CampaignBudgetDTO","description":"The associated campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the campaign budget.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"CampaignBudgetTypeValues","description":"The type of the campaign budget:\n\n- spend indicates that the budget is limited by the amount discounted by the promotions in the associated campaign.\n- usage indicates that the budget is limited by the number of times the promotions of the associated campaign have been used.\n- use_by_attribute indicates that the budget is limited by the number of times the promotions of the associated campaign have been used by a specific attribute value (for example, per customer)\n- spend_by_attribute indicates that the budget is limited by the amount discounted by the promotions in the associated campaign by a specific attribute value (for example, per customer)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"null \| number","description":"The limit of the campaign budget.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"number","description":"The usage from the campaign budget's limit:\n\n- If the budget's type is spend, the value of this attribute is the amount discounted so far by the promotions in the associated campaign.\n- If the budget's type is usage, the value of this attribute is the number of times the promotions of the associated campaign have been used so far.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"string","description":"The currency of the campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"string","description":"The attribute that the budget limit is applied to. By default,\nthe budget is applied globally. If the type is use_by_attribute, this field indicates the \nattribute the budget is tracked by. For example, customer_id means the budget is tracked per customer.","optional":true,"defaultValue":"","example":"customer_id","expandable":false,"children":[],"since":"2.11.0"},{"name":"usages","type":"CampaignBudgetUsageDTO[]","description":"The usages of the campaign budget. This is only set if the\nbudget's type is use_by_attribute or spend_by_attribute.\nEach usage tracks the budget usage for a specific attribute value.","optional":true,"defaultValue":"","expandable":false,"children":[],"since":"2.11.0"}]},{"name":"promotions","type":"PromotionDTO[]","description":"The associated promotions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of the promotion.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"string","description":"The code of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"PromotionTypeValues","description":"The type of the promotion:\n\n- standard indicates that a promotion is a standard one applied with conditions.\n- buyget indicates that a promotion is a "Buy X get Y" promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"PromotionStatusValues","description":"The status of the promotion:\n\n- active promotion is available for user to consume\n- inactive promotion is no longer available to the user\n- draft promotion is currently being prepared","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_automatic","type":"boolean","description":"Whether the promotion is applied automatically.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Whether the promotion is tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"null \| number","description":"The maximum number of times this promotion can be used across all orders.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"used","type":"number","description":"The number of times this promotion has been used in completed orders.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"application_method","type":"ApplicationMethodDTO","description":"The associated application method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"PromotionRuleDTO[]","description":"The rules of the promotion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign_id","type":"null \| string","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"campaign","type":"CampaignDTO","description":"The associated campaign.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PromotionDTO"/>