Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

ApplicationMethod - Promotion Module Data Models Reference

This documentation provides a reference to the ApplicationMethod data model. It belongs to the Promotion Module.

idPrimaryKeyModifier<IdProperty>
The ID of the application method.
typeEnumProperty<typeof ApplicationMethodType>
The application method's type. If it's fixed, the promotion discounts a fixed amount. If it's percentage, the promotion discounts a percentage.
target_typeEnumProperty<typeof ApplicationMethodTargetType>
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.
promotionBelongsTo<Promotion>
The associated promotion.
target_rulesManyToMany<PromotionRule>
The associated target rules.
buy_rulesManyToMany<PromotionRule>
The associated buy rules.
valueBigNumberPropertyOptional
The value of the application method
currency_codeTextPropertyOptional
The currency code of the application method. @example usd
max_quantityNumberPropertyOptional
The max quantity allowed in the cart for the associated promotion to be applied.
apply_to_quantityNumberPropertyOptional
The quantity that results from matching the buyget promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is 1.
buy_rules_min_quantityNumberPropertyOptional
The minimum quantity required for a buyget promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is 2.
allocationEnumProperty<typeof ApplicationMethodAllocation>Optional
How is the promotion amount discounted. each means the discounted amount is applied on each applicable item; across means the discounted amount is split accross the applicable items.
Was this page helpful?