Evaluate promotions
Evaluates a cart’s promotions, discount coupons and implicit promotions, either by specified itemId or by SKU (based on the customer specific configuration set in the backend)
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Body
Prices conditions
List of item information objects
Trace ID, used to trace logs
true: user logged in<br /> false: user is not logged in
User ID
A list of coupon codes that are applicable only for coupons. For coupons, the response includes promo codes associated with the coupon. For promotions, the response includes an empty array.
Shipping cost for the entire cart. You can use this shipping
array if you want to add shipping cost for the entire cart.<br /> If you want to add shipping cost for individual items, you can provide details for each item using items.shippingMethodId
and items.shippingPrice
fields.
Date for which the promotions to be evaluated
Segment the user belongs to
Response
Indicates if promotion is successfully evaluated
Was this page helpful?