The apply
endpoint is used to apply promotions to an order in an e-commerce system. A successful call to this endpoint will;
-
qualify any currently applied promotions in the order to ensure they still apply
-
validate and apply the coupon code sent with the request, if any
-
and apply any automatic promotions that the order qualifies for.
The promotion combination rules that you have configured on your account will decide if and how multiple promotions are applied to an order.
All successfully applied promotions will be returned in the appliedPromotions
property of the Order
object in the response. This is a combination of successfully applied automatic promotions and any coupon code or promotion that you specified in the request.
You should always pass back the array of applied promotions in the
Order
object with subsequent requests to theapply
endpoint so that the applied promotions can be checked against the updated cart or order to ensure they still meet the qualification rules of the promotion.
See the guide on Reward Application for more information.