Commerce Webstore Promotions, Evaluate Action

If a store is segmented into markets, this API looks at the language parameter appended to the URL to determine the shopper’s locale and returns the appropriate values.

Resource

/commerce/promotions/actions/evaluate

Available version

56.0

HTTP methods

POST

Request body for POST

JSON example

{
   "cart":{
      "cartDeliveryGroups":[
         {
            "cartDeliveryGroupId":"0a7xx000000001dAAA",
            "cartDeliveryGroupMethods":[
               {
                  "cartDeliveryMethodId":"2Dmxx0000004MMuCAM",
                  "price":"25.00"
               },
               {
                  "cartDeliveryMethodId":"2Dmxx0000004MMuCAG",
                  "price":"25.00"
               }
            ]
         }
      ],
      "currencyIsoCode":"USD",
      "id":"3z6xx000000001eAAA",
      "cartAdjustmentGroups":[
         {
            "id":"0m9xx0000006j3SAAQ",
            "cartId":"3z6xx000000001eAAA",
            "priceAdjustmentCauseId":"0c8xx0000000001AAA",
            "adjustmentDescription":"test",
            "priority":2,
            "adjustmentType":"AdjustmentPercentage",
            "adjustmentValue":-10.0,
            "baseAmount":-1.8,
            "adjustmentBasisReference":null
         }
      ],
      "cartItems":[
         {
            "id":"01txx0000006i2SAAQ",
            "type":"Product",
            "product2Id":"01txx0000006i2SAAQ",
            "sku":null,
            "quantity":1,
            "salesPrice":20,
            "totalNetAmount":18,
            "cartDeliveryGroupId":"0a7xx000000001dAAA",
            "cartItemPriceAdjustments":[
               {
                  "id":"0U1xx0000006f1DCAQ",
                  "cartItemId":"01txx0000006i2SAAQ",
                  "priceAdjustmentCauseId":"0c8xx0000000001AAA",
                  "priority":1,
                  "adjustmentDescription":null,
                  "adjustmentType":"AdjustmentAmount",
                  "adjustmentAmountScope":"Total",
                  "adjustmentTargetType":"Item",
                  "adjustmentBasisReference":null,
                  "baseAmount":-2,
                  "adjustmentValue":-2.0
               }
            ]
         }
      ]
   },
   "couponCodes":[
      
   ],
   "effectiveAccountId":null,
   "webStoreId":"0ZExx0000000002GAA",
   "isItemizeHeaderAdjustments":"false",
   "scope":"Delivery"
}

Properties

Name	Type	Description	Required or Optional	Available Version
cart	Promotion Cart Input	Cart and its items.	Required	56.0
cartDelivery​Groups	Promotion Cart Delivery Group Input[]	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	String[]	Collection of coupon codes to enable promotions. A customer can apply a maximum of two coupons per cart.	Optional	56.0
effectiveAccountId	String	ID of the account for which the request is made.	Optional	56.0
isItemizeHeader​Adjustments	Boolean	Specifies whether order-level adjustments are itemized (true) or not (false). If unspecified, the default value is false.	Optional	56.0
parentProducts	Promotion Parent Products Input[]	Collection of parent product IDs mapped to their variation product IDs.	Optional	56.0
productCategories	Promotion Product Categories Input[]	Collection of product IDs mapped to their associated category IDs.	Optional	56.0
scope	String	Promotion evaluation scope. Valid values are: Cart Delivery If no value is provided, default is Cart. If you want any shipping promotions to be evaluated, set to Delivery.	Optional	60.0
segments	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	56.0
webStoreId	List<String>	ID of the store for which the request is made. If unspecified, defined segments must be used instead.	Optional	56.0

Response body for POST

Promotion Evaluation