Redeem Reward

POST

customers

{merchant_id}

claimed_rewards

curl --request POST \
  --url https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards \
  --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>",
          "sort_key": 123,
          "title": "<string>"
        }
      ],
      "session_options": "null",
      "auto_refund_seconds": "null",
      "expiry_options": {
        "kind": "does_not_expire",
        "seconds": "null"
      },
      "redeemable_expiry_options": "null",
      "kind": "active_subscription_discount_voucher",
      "recurring_cycle_limit": 123
    },
    "state": "approved",
    "session": {
      "kind": "cart",
      "token": "<string>"
    },
    "auto_refund_at": "<string>",
    "expires_at": "<string>"
  }
}

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 multiplier of the reward being claimed. Only supported for custom reward type

variant_id

string

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

Response

201

application/json

201

claimed_reward

object

required

claimed_reward.id

number

required

claimed_reward.claimed_at

string

required

ISO 8601 timestamp indicating when this reward was claimed

claimed_reward.point_cost

number

required

The number of points it cost to claim this reward

claimed_reward.redeemable

object

required

claimed_reward.reward

object

required

claimed_reward.reward.id

number

required

claimed_reward.reward.title

string

required

claimed_reward.reward.description

string | null

required

claimed_reward.reward.sort_key

number

required

claimed_reward.reward.content

object

required

claimed_reward.reward.point_cost

number

required

claimed_reward.reward.method

enum<string>

required

Available options:

voucher

claimed_reward.reward.discount_type

enum<string>

required

Available options:

flat,

percentage

claimed_reward.reward.discount_amount

number

required

claimed_reward.reward.minimum_spend

number | null

required

claimed_reward.reward.usage_limit

number

required

claimed_reward.reward.min_redemption_amount

enum<number>

required

Available options:

1

claimed_reward.reward.max_redemption_amount

enum<number>

required

Available options:

1

claimed_reward.reward.max_free_shipping

enum<string> | null

required

Available options:

null

claimed_reward.reward.site_id

number

required

claimed_reward.reward.target_site

object

required

claimed_reward.reward.order_type

enum<string>

required

Available options:

subscription

claimed_reward.reward.target_type

enum<string>

required

Available options:

all

claimed_reward.reward.target_collections

object[]

required

claimed_reward.reward.target_products

object[]

required

claimed_reward.reward.session_options

enum<string> | null

required

Available options:

null

claimed_reward.reward.auto_refund_seconds

enum<string> | null

required

Available options:

null

claimed_reward.reward.expiry_options

object

required

claimed_reward.reward.redeemable_expiry_options

enum<string> | null

required

Available options:

null

claimed_reward.reward.kind

enum<string>

required

Available options:

active_subscription_discount_voucher

claimed_reward.reward.recurring_cycle_limit

number | null

required

claimed_reward.state

enum<string>

required

Available options:

approved,

declined,

expired,

pending,

void

claimed_reward.session

object | null

required

For session-based rewards, this includes information about the session in which the reward was claimed

claimed_reward.auto_refund_at

string | null

required

ISO 8601 timestamp indicating when this reward will automatically be voided and refunded if it has not yet been used, or null if not applicable

claimed_reward.expires_at

string | null

requireddeprecated

Deprecated in favour of auto_refund_at

List Available Rewards Refund Reward

curl --request POST \
  --url https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards \
  --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>",
          "sort_key": 123,
          "title": "<string>"
        }
      ],
      "session_options": "null",
      "auto_refund_seconds": "null",
      "expiry_options": {
        "kind": "does_not_expire",
        "seconds": "null"
      },
      "redeemable_expiry_options": "null",
      "kind": "active_subscription_discount_voucher",
      "recurring_cycle_limit": 123
    },
    "state": "approved",
    "session": {
      "kind": "cart",
      "token": "<string>"
    },
    "auto_refund_at": "<string>",
    "expires_at": "<string>"
  }
}

API reference

Resources

Webhooks

Path Parameters

Body

Response