Newer Version Available

This content describes an older version of this product. View Latest

Promotion Details

Output representation of the details of an eligible promotion.
Property Name Type Description Filter Group and Version Available Version
coupon Promotion Coupon Availability Provides 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, 64.0 64.0
currency​IsoCode String Three-letter ISO 4217 code of the active monetary currency associated with the promotion. Small, 60.0 60.0
description String The description of the promotion. Big, 64.0 64.0
display​Name String Name of the eligible promotion. Small, 60.0 60.0
id String The ID of the promotion. Big, 64.0 64.0
product​Details Product Details The details of a product associated with the recommended promotion. Big, 64.0 64.0
priority Integer Number that determines the priority of the promotion in a list of eligible promotions.

Multiple promotions can have the same priority number.

Small, 60.0 60.0
imageUrl String The URL of the image associated with the promotion. Big, 64.0 64.0
is​Enrolled Boolean Indicates whether a customer has enrolled for the promotion. Big, 64.0 64.0
is​Enrollment​Required Boolean Indicates whether customers must enroll for the promotion. Big, 64.0 64.0
name String The name of the promotion. Big, 64.0 64.0
promotion​Code String Code of the eligible promotion. Small, 60.0 60.0
promotion​PageUrl String The URL of the promotion page. Big, 64.0 64.0
start​Date​Time String Start date and time of the promotion. Big, 64.0 64.0
end​Date​Time String End date and time of the promotion. Big, 64.0 64.0
terms​And​Condition String The terms and condition of the promotion Big, 64.0 64.0
is​Automatic Boolean Indicates whether the promotion is automatically applied for eligible carts (true) or not (false). The default value is false Small, 60.0 60.0