Skip to main content
POST
cURL

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

merchant_id
string
required

The ID of the customer in your platform or ecommerce store. The reward will be redeemed for this customer

Body

application/json

Body

reward_id
number
required

The ID of the reward to claim

multiplier
number

The number of times to claim this reward in a single request. Only supported for store_fulfilment custom rewards; voucher-method rewards reject a multiplier greater than 1, as each claim requires a unique code.

variant_id
string

The Shopify variant being claimed. Required when the reward is a seamless product reward

shopify_action_id
string
attribution
enum<string>
Available options:
redemption_notification
session
object

Response

201

claimed_reward
object
required