<- Loyalty API

Loyalty API

Delete loyalty reward

DELETE

 /v2/loyalty/rewards/{reward_id}

Deletes a loyalty reward by doing the following:

  • Returns the loyalty points back to the loyalty account.
  • If an order ID was specified when the reward was created (see CreateLoyaltyReward), it updates the order by removing the reward and related discounts.

You cannot delete a reward that has reached the terminal state (REDEEMED).

Permissions:LOYALTY_WRITE

Guide

Delete loyalty reward

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

reward_id

string

Required

The ID of the loyalty reward to delete.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes