Add Coupon

A coupon is a code that consists of a special series of characters, or string, used by customers to get a discounted price or limited offer on the cart's items. This add endpoint is used for this purpose.

Payload

AddCouponPayload

Response

Success

Error

cart.addCoupon.success

Usage

To perform the action of applying a coupon to the cart's items, the developer may call the add() as shown below.

Events

This endpoint may trigger two events, the onCouponAdded and onCouponAdditionFailed events.

onCouponAdded

This event is triggered when applying a new coupon by the customer is done without having any errors coming back from the backend.

onCouponAdditionFailed

This event is triggered when applying a new coupon by the customer is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#