Skip to main content
POST
cURL
Use this endpoint to redeem a gift_card reward. If the redemption is successful, the new claimed reward and a unique gift card code will be included in the response. The new gift card code can be seen once only in the in the gift_card_code response field. It’s important that you instruct the customer to copy and save the code.

Authorizations

Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Path Parameters

site_id
number
required

Your LoyaltyLion Site ID

Query Parameters

channel
enum<string>

The sales channel from which this request is made

Available options:
web,
pos,
mobile
language
string

The language to use for the request. If not provided, the site's default language will be used

Pattern: ^[a-z]{2,3}$|^[a-z]{2,3}-[a-z0-9]{2,4}$
country
string

ISO 3166-1 alpha-2 country code for the customer. Used to filter rewards by country availability. If not provided, the site default is used

Body

application/json

Body

reward_id
number
required

The LoyaltyLion ID of the reward to redeem

customer_merchant_id
string
required

The ID of the customer (in your ecommerce store or platform) to redeem the reward for. For Shopify stores, you can pass either a GID or a regular numeric ID.

This must be a customer whose state is enrolled

Response

201

gift_card_code
string
required

The full gift card code. This is the only time the full code can be seen through the API

Example:

"8c88rfd8t8d6yxp9"

claimed_reward
object
required

The new claimed reward. The last few characters of the gift card code can be found in claimed_reward.redeemable.code_last_characters

customer
object
required

The customer object, updated as of the reward redemption, i.e. their claimed_rewards will include the new redemption. This customer will always have state set to enrolled, as only enrolled customers can redeem rewards