Newer Version Available

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

ConnectApi.PromotionEvaluateInput

Find promotions that the customer is eligible for and compute their discounts.
Property Type Description Required or Optional Available Version
cart ConnectApi.PromotionCart​Input Cart and its items. Required 57.0
cartDelivery​Groups List<ConnectApi.PromotionCartDeliveryGroupInput> List of cart delivery groups associated with the items in the cart. Available if shipping promotions are enabled. Required when evaluating shipping promotions 57.0
couponCodes List<String> List of coupon codes to enable promotions. A customer can apply a maximum of two coupons per cart. Optional 57.0
effectiveAccount​Id String ID of the account for which the request is made. Required if segments isn’t specified 57.0
isItemizeHeader​Adjustments Boolean Specifies whether order-level adjustments are itemized (true) or not (false). If unspecified, the default value is false. Optional 57.0
parentProducts List<ConnectApi.PromotionParentProductsInput> Map of the parent product ID to its variation product IDs. Optional 57.0
productCategories List<ConnectApi.PromotionProductCategoriesInput> Map of product IDs to their associated category IDs. Optional 57.0
segments List<String> All promotions associated with promotion segments specified in this list are active and can be evaluated against the cart. Additionally, any segments associated with a store or buyer group are also still evaluated against the cart. If this field is not present, only the promotions associated with a store or buyer group are evaluated. Optional 57.0
webStoreId String ID of the store for which the request is made. If unspecified, defined segments must be used instead. Optional 57.0