Gift Cards

Apply a gift card to an order

Deducts amount_cents from the gift card and binds the redemption to the order. Idempotent against the (code, order_id, amount_cents) tuple at the service layer.

post/api/v1/gift-cards/redeem

Request

  • Base URL: https://makeup.land
  • URL: https://makeup.land/api/v1/gift-cards/redeem
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional client-generated idempotency token (recommended: UUIDv4). Retries with the same key within 24h replay the original response.

Request body

codestring required

Gift card code in GML-XXXX-XXXX-XXXX or GMLXXXXXXXXXXXX form

amount_centsinteger required

Amount in agorot to deduct from the card

order_idstring required

Order the redemption is being applied to

Response

Redemption recorded

successtrue required
redeemed_centsinteger required

Amount in integer agorot (100 = ₪1)

remaining_balance_centsinteger required

Amount in integer agorot (100 = ₪1)

Changes

No recorded changes to this operation across all 1 revision of this API.