v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Loyalty

RedeemLoyaltyReward

Redeems a loyalty reward.

The endpoint sets the reward to the REDEEMED terminal state.

If you are using your own order processing system (not using the Orders API), you call this endpoint after the buyer paid for the purchase.

After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.

post/v2/loyalty/rewards/{reward_id}/redeem

Path parameters

reward_idstring required

The ID of the loyalty reward to redeem.

Request body

idempotency_keystring required

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

location_idstring required

The ID of the location where the reward is redeemed.

Example request

{
  "idempotency_key": "98adc7f7-6963-473b-b29c-f3c9cdd7d994",
  "location_id": "P034NEENMD09F"
}

Response

Success

Example response

{
  "event": {
    "created_at": "2020-05-08T21:56:00Z",
    "id": "67377a6e-dbdc-369d-aa16-2e7ed422e71f",
    "location_id": "P034NEENMD09F",
    "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
    "redeem_reward": {
      "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
      "reward_id": "9f18ac21-233a-31c3-be77-b45840f5a810"
    },
    "source": "LOYALTY_API",
    "type": "REDEEM_REWARD"
  }
}