Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ConnectApi.PromotionEvaluateInput
Find promotions that the customer is eligible for and compute their discounts.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| cart | ConnectApi.PromotionCartInput | Cart and its items. | Required | 57.0 |
| cartDeliveryGroups | 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> | Collection of coupon codes to enable promotions. A customer can apply a maximum of two coupons per cart. | Optional | 57.0 |
| effectiveAccountId | String | ID of the account for which the request is made. | Required if segments isn’t specified | 57.0 |
| isItemizeHeaderAdjustments | 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> | Collection of parent product IDs mapped to their variation product IDs. | Optional | 57.0 |
| productCategories | List<ConnectApi.PromotionProductCategoriesInput> | Collection of product IDs mapped to their associated category IDs. | Optional | 57.0 |
| segments | List<String> | All promotions associated with promotion segments specified in this collection 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 |