GET
/
v2
/
customers
/
{merchant_id}
/
available_rewards
cURL
curl --request GET \
  --url https://api.loyaltylion.com/v2/customers/{merchant_id}/available_rewards \
  --header 'Authorization: Bearer <token>'
{
  "rewards": [
    {
      "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
    }
  ]
}
Returns a list of the rewards currently available to this customer. Rewards are available to a customer for the purposes of this API if:
  • The reward is enabled
  • If a customer is in a loyalty tier, the reward is available on that tier
  • The reward is supported based on your platform (see table below)
Rewards will be returned even if the customer does not currently have enough points to redeem them.

Supported rewards by platform

PlatformSupported rewards
Shopifyone-off discount rewards, custom rewards, checkout rewards, free product vouchers, seamless free products
Adobe Commerce (Magento)one-off discount rewards, custom rewards, free product vouchers
BigCommerceone-off discount rewards, custom rewards, free product vouchers
Customcustom rewards

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

Query Parameters

site_id
number

By default this endpoint will return rewards across all sites in your program. If you have a multi-site program, you can specify a site ID here to return only rewards for that site

Response

200
application/json

200

The response is of type object.