curl --request POST \
--url https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"reward_id": 123,
"multiplier": 123,
"variant_id": "<string>"
}'
{
"claimed_reward": {
"id": 123,
"claimed_at": "<string>",
"point_cost": 123,
"redeemable": {
"redeemable_type": "fulfilment",
"fulfilled": true,
"fulfilled_at": "<string>",
"expires_on": null
},
"reward": {
"id": 123,
"title": "<string>",
"description": "<string>",
"sort_key": 123,
"content": {},
"point_cost": 123,
"method": "voucher",
"discount_type": "flat",
"discount_amount": 123,
"minimum_spend": 123,
"usage_limit": 123,
"min_redemption_amount": 1,
"max_redemption_amount": 1,
"max_free_shipping": null,
"site_id": 123,
"target_site": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"order_type": "subscription",
"target_type": "all",
"target_collections": [
{
"id": 123,
"url": "<string>",
"restriction_text": "<string>"
}
],
"target_products": [
{
"id": 123,
"variant_id": 123,
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"title": "<string>",
"sort_key": 123
}
],
"session_options": null,
"auto_refund_seconds": null,
"expiry_options": {
"kind": "does_not_expire",
"seconds": null
},
"redeemable_expiry_options": null,
"supported_channels": [
"web"
],
"kind": "active_subscription_discount_voucher",
"recurring_cycle_limit": 123
},
"state": "approved",
"session": {
"kind": "cart",
"token": "<string>"
},
"auto_refund_at": "<string>",
"expires_at": "<string>"
}
}
curl --request POST \
--url https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"reward_id": 123,
"multiplier": 123,
"variant_id": "<string>"
}'
{
"claimed_reward": {
"id": 123,
"claimed_at": "<string>",
"point_cost": 123,
"redeemable": {
"redeemable_type": "fulfilment",
"fulfilled": true,
"fulfilled_at": "<string>",
"expires_on": null
},
"reward": {
"id": 123,
"title": "<string>",
"description": "<string>",
"sort_key": 123,
"content": {},
"point_cost": 123,
"method": "voucher",
"discount_type": "flat",
"discount_amount": 123,
"minimum_spend": 123,
"usage_limit": 123,
"min_redemption_amount": 1,
"max_redemption_amount": 1,
"max_free_shipping": null,
"site_id": 123,
"target_site": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"order_type": "subscription",
"target_type": "all",
"target_collections": [
{
"id": 123,
"url": "<string>",
"restriction_text": "<string>"
}
],
"target_products": [
{
"id": 123,
"variant_id": 123,
"sku": "<string>",
"url": "<string>",
"image_url": "<string>",
"title": "<string>",
"sort_key": 123
}
],
"session_options": null,
"auto_refund_seconds": null,
"expiry_options": {
"kind": "does_not_expire",
"seconds": null
},
"redeemable_expiry_options": null,
"supported_channels": [
"web"
],
"kind": "active_subscription_discount_voucher",
"recurring_cycle_limit": 123
},
"state": "approved",
"session": {
"kind": "cart",
"token": "<string>"
},
"auto_refund_at": "<string>",
"expires_at": "<string>"
}
}
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
The ID of the customer in your platform or ecommerce store. The reward will be redeemed for this customer
Body
The body is of type object
.
201
The response is of type object
.