Menu

ApplicationMethodDTO

The application method details.

idstring
The ID of the application method.
typeApplicationMethodTypeValuesOptional
The type of the application method indicating how the associated promotion is applied.
target_typeApplicationMethodTargetTypeValuesOptional
The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order.
allocationApplicationMethodAllocationValuesOptional
The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart.
valuenumberOptional
The discounted amount applied by the associated promotion based on the type.
currency_codestringOptional
The currency code of the application method
max_quantitynull | numberOptional
The max quantity allowed in the cart for the associated promotion to be applied.
buy_rules_min_quantitynull | numberOptional
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.
apply_to_quantitynull | numberOptional
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.
promotionstring | PromotionDTOOptional
The promotion of the application method.
target_rulesPromotionRuleDTO[]Optional
The target rules of the application method.
buy_rulesPromotionRuleDTO[]Optional
The buy rules of the application method.
Was this page helpful?
Edit this page