<- Loyalty API

Loyalty API

Create loyalty reward

POST

 /v2/loyalty/rewards

Creates a loyalty reward.

In the process, the endpoint does following:

  • Uses the reward_tier_id in the request to determine the number of points to lock for this reward.
  • If the request includes order_id, it adds the reward and related discount to the order.

After a reward is created, the points are locked and not available for the buyer to redeem another reward.

Permissions:LOYALTY_WRITE

Guide

Create loyalty reward

Try in API Explorer
Link to section

Request body

Example code

Link to section

reward

Required

The reward to create.

Show attributes
Link to section

idempotency_key

string

Required

A unique string that identifies this CreateLoyaltyReward request. Keys can be any valid string, but must be unique for every request.

Min Length
1
Max Length
128
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

reward

The loyalty reward created.

Show attributes