Exchange

This endpoint is used to exchange a customer's accumulated points for any preset reward, such as free goods or discounts.

TIP

The exchange endpoint has been implemented in the Loyalty Web Component , and It's all setup to save developer's time and effort.

Payload `authenticated`

ExchangePayload

prize_id

string

required

The id of the prize to be awared

cart_id

string

optional

The id of the customer cart

Response

Success

Error

loyalty.exchange.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

Loyalty

optional

Data is available when the success is true

message

string

optional

cart

object

optional

Usage

To perform the action of exchanging a customer's accumulated points for any preset reward, the method exchange() may be called as below:

Events

This endpoint may trigger two events, the onExchangeSucceeded and onExchangeFailed events.

onExchangeSucceeded

This event is triggered when performing the action of exchanging a customer's accumulated points for any preset reward is done without having any errors coming back from the backend.

onExchangeFailed

This event is triggered when performing the action of exchanging a customer's accumulated points for any preset reward is not completed and an error has occurred.

Payload authenticated#

Response#

Usage#

Events#

onExchangeSucceeded#

onExchangeFailed#

Payload `authenticated`

Response

Usage

Events

onExchangeSucceeded

onExchangeFailed