Promotion Details

Output representation of the details of an eligible promotion.

Property NameTypeDescriptionFilter Group and VersionAvailable Version
additional​PromotionFieldsMap<String, Object>Values of the promotion fields that are mapped in the context definition.Big, 60.060.0
couponDetailsPromotion Coupon AvailabilityProvides the details of the coupon eligible for the recommended promotion or specifies the reason why there isn’t an eligible coupon for the promotion.Big, 60.060.0
currency​IsoCodeStringThree-letter ISO 4217 code of the active monetary currency associated with the promotion.Small, 60.060.0
descriptionStringThe description of the promotion.Big, 60.060.0
display​NameStringName of the eligible promotion.Small, 60.060.0
end​DateTimeStringEnd date and time of the promotion.Big, 60.060.0
enrollment​DetailsEnrollment Details[]Details of a customer’s enrollment in a promotion.Big, 60.060.0
is​AutomaticBooleanIndicates whether the promotion is automatically applied for eligible carts (true) or not (false). The default value is false.Small, 63.063.0
priorityNumberIntegerNumber that determines the priority of the promotion in a list of eligible promotions. Multiple promotions can have the same priority number.Small, 60.060.0
promotion​CodeStringCode of the eligible promotion.Small, 60.060.0
promotion​EligibleRulesPromotion Rules List[]List of promotion rules that are eligible for the customer’s cart.Big, 60.060.0
promotionIdStringID of the eligible promotion.Big, 60.060.0
promotionLimitsPromotion Limit[]List of the promotion’s cart level and cart item level limits.Big, 60.060.0
start​Date​TimeStringStart date and time of the promotion.Big, 60.060.0
terms​And​ConditionStringTerms and condition of the promotion.Big, 60.060.0