Redeemables reference

🚧

Beta feature

Stackable discounts API is currently in Open Beta. Note that Beta features can change during the beta period. Feel free to test and share the feedback. For more updates, please follow our release notes.

Redeemables array can gather up to 5 objects. Each array element represents an object that will be redeemed when calling the API. In the reference below, you can learn how to pass each type of redeemable in the payload.

Redeemable type

Payload

Reference

Coupon code (discount voucher)

{
"object": "voucher",
"id": "VOUCHER_CODE"
}

object (string) required
id (string) required is a voucher code or a unique internal identifier of a voucher code,
example "id":

  • when using voucher code: blackFriday20
  • when using voucher id: v_Vt0mOlx2OWBmFe9f3e3ElgWSbYsEPTbJ

Gift card (gift voucher)

{
"object": "voucher",
"id": "GIFT_VOUCHER_CODE",
"gift": {
"credits": 2000
}
}

object (string) required
id (string) required is a gift card code or unique internal identifier of a voucher code,
example "id":

  • when using voucher code: gift-87lta6
  • when using voucher id: v_Vt0mOlx2OWBmFe9f3e3ElgWSbYsEPTbJ
    gift (object) required
    gift.credits (integer) define the amount that will be deducted from the card balance and applied to the order. You need to multiply the credits amount by 100 in the payload (for example $20 is 2000 in the gift.credits valu).

Promotion tier

{
"object": "promotion_tier",
"id": "PROMOTION_TIER_ID"
}

object (string) required
id (string) required is a unique internal identifier of a promotion tier,
example "id": promo_DkBL24GWmNZ1A75bhEiBTNWO

Promotion stack

Important!
Note that you can pass only one promotion stack in a single validation/redemption call. Each stack can include up to 5 promotion tiers.

{
"object": "promotion_stack",
"id": "STACK_ID"
}

object (string) required
id (string) required is a unique internal identifier of a promotion stack,
example "id": stack_3Q4EJpZqg3DI5IRwgBYfsb37

Loyalty card

{
"object": "voucher",
"id": "LOYALTY_CARD_CODE",
"reward": {
"id": "REWARD_ID",
"points": 200
}
}

object (string) required
id (string) required is a loyalty card code or a unique internal identifier of a loyalty card, example:

  • when using voucher code: card-87lta6
  • when using voucher id: v_Vt0mOlx2OWBmFe9f3e3ElgWSbYsEPTbJ

reward (object) required is required to redeem loyalty card.
reward.id (string) required is a unique reward identifier.
reward.points (intiger) defines how many points will be used to pay for the order (required for redeeming pay with points reward).

Referral code

{
"object": "voucher",
"id": "REFERRAL_CODE"
}

object (string) required
id (string) required is a referral code or a unique internal identifier of a referral code,
example "id":

  • when using voucher code: card-87lta6
  • when using voucher id: v_Vt0mOlx2OWBmFe9f3e3ElgWSbYsEPTbJ