Refund Reward

cURL

curl --request POST \
  --url https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards/{claimed_reward_id}/refund \
  --header 'Authorization: Bearer <token>'

{
  "claimed_reward": {
    "id": 123,
    "claimed_at": "<string>",
    "point_cost": 123,
    "redeemable": {
      "redeemable_type": "<string>",
      "fulfilled": true,
      "fulfilled_at": "<string>",
      "expires_on": "<unknown>"
    },
    "reward": {
      "id": 123,
      "title": "<string>",
      "description": "<string>",
      "sort_key": 123,
      "content": {},
      "point_cost": 123,
      "method": "<string>",
      "discount_type": "flat",
      "discount_amount": 123,
      "minimum_spend": 123,
      "usage_limit": 123,
      "min_redemption_amount": 123,
      "max_redemption_amount": 123,
      "max_free_shipping": "<unknown>",
      "site_id": 123,
      "target_site": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "order_type": "<string>",
      "target_type": "<string>",
      "target_collections": [
        {
          "id": 123,
          "url": "<string>",
          "restriction_text": "<string>"
        }
      ],
      "target_products": [
        {
          "inventory_count": 123,
          "sort_key": 123,
          "id": 123,
          "variant_id": 123,
          "sku": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "title": "<string>",
          "handle": "<string>"
        }
      ],
      "session_options": "<unknown>",
      "auto_refund_seconds": "<unknown>",
      "expiry_options": {
        "kind": "<string>",
        "seconds": "<unknown>"
      },
      "redeemable_expiry_options": "<unknown>",
      "supported_channels": [
        "web"
      ],
      "kind": "<string>",
      "recurring_cycle_limit": 123
    },
    "state": "approved",
    "session": {
      "kind": "cart",
      "token": "<string>"
    },
    "auto_refund_at": "<string>",
    "expires_at": "<string>"
  },
  "remote_resource_deleted": true
}

POST

customers

{merchant_id}

claimed_rewards

{claimed_reward_id}

refund

cURL

curl --request POST \
  --url https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards/{claimed_reward_id}/refund \
  --header 'Authorization: Bearer <token>'

{
  "claimed_reward": {
    "id": 123,
    "claimed_at": "<string>",
    "point_cost": 123,
    "redeemable": {
      "redeemable_type": "<string>",
      "fulfilled": true,
      "fulfilled_at": "<string>",
      "expires_on": "<unknown>"
    },
    "reward": {
      "id": 123,
      "title": "<string>",
      "description": "<string>",
      "sort_key": 123,
      "content": {},
      "point_cost": 123,
      "method": "<string>",
      "discount_type": "flat",
      "discount_amount": 123,
      "minimum_spend": 123,
      "usage_limit": 123,
      "min_redemption_amount": 123,
      "max_redemption_amount": 123,
      "max_free_shipping": "<unknown>",
      "site_id": 123,
      "target_site": {
        "id": 123,
        "name": "<string>",
        "url": "<string>"
      },
      "order_type": "<string>",
      "target_type": "<string>",
      "target_collections": [
        {
          "id": 123,
          "url": "<string>",
          "restriction_text": "<string>"
        }
      ],
      "target_products": [
        {
          "inventory_count": 123,
          "sort_key": 123,
          "id": 123,
          "variant_id": 123,
          "sku": "<string>",
          "url": "<string>",
          "image_url": "<string>",
          "title": "<string>",
          "handle": "<string>"
        }
      ],
      "session_options": "<unknown>",
      "auto_refund_seconds": "<unknown>",
      "expiry_options": {
        "kind": "<string>",
        "seconds": "<unknown>"
      },
      "redeemable_expiry_options": "<unknown>",
      "supported_channels": [
        "web"
      ],
      "kind": "<string>",
      "recurring_cycle_limit": 123
    },
    "state": "approved",
    "session": {
      "kind": "cart",
      "token": "<string>"
    },
    "auto_refund_at": "<string>",
    "expires_at": "<string>"
  },
  "remote_resource_deleted": true
}

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

claimed_reward_id

number

required

The ID of the claimed reward to refund

Response

200

claimed_reward

object

required

Show child attributes

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

Fulfilment · object

required

Fulfilment
POS Action
Product
Gift Card
Voucher

Show child attributes

claimed_reward.redeemable.redeemable_type

string

required

Allowed value: "fulfilment"

claimed_reward.redeemable.fulfilled

boolean

required

Indicates if this reward has been fulfilled

claimed_reward.redeemable.fulfilled_at

string | null

required

An ISO8601 timestamp representing when the reward was fulfilled, or null if it is not yet fulfilled

claimed_reward.redeemable.expires_on

null

required

This field is always null for fulfilment rewards because they do not expire

claimed_reward.reward

Active Subscription Discount Voucher · object

required

Show child attributes

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

Show child attributes

claimed_reward.reward.content.{key}

any

claimed_reward.reward.point_cost

number

required

claimed_reward.reward.method

string

required

Allowed value: "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

number

required

claimed_reward.reward.max_redemption_amount

number

required

claimed_reward.reward.max_free_shipping

null

required

claimed_reward.reward.site_id

number

required

claimed_reward.reward.target_site

object

required

Show child attributes

claimed_reward.reward.target_site.id

number

required

claimed_reward.reward.target_site.name

string

required

claimed_reward.reward.target_site.url

string

required

claimed_reward.reward.order_type

string

required

Allowed value: "subscription"

claimed_reward.reward.target_type

string

required

Allowed value: "all"

claimed_reward.reward.target_collections

object[]

required

Show child attributes

claimed_reward.reward.target_collections.id

claimed_reward.reward.target_collections.url

string

claimed_reward.reward.target_collections.restriction_text

string

claimed_reward.reward.target_products

object[]

required

Show child attributes

claimed_reward.reward.target_products.inventory_count

number | null

required

The current inventory count of this product variant, or null if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward

claimed_reward.reward.target_products.sort_key

number

required

claimed_reward.reward.target_products.id

claimed_reward.reward.target_products.variant_id

number

claimed_reward.reward.target_products.sku

string

claimed_reward.reward.target_products.url

string

claimed_reward.reward.target_products.image_url

string

claimed_reward.reward.target_products.title

string

claimed_reward.reward.target_products.handle

string

claimed_reward.reward.session_options

null

required

claimed_reward.reward.auto_refund_seconds

null

required

claimed_reward.reward.expiry_options

object

required

Show child attributes

claimed_reward.reward.expiry_options.kind

string

required

Allowed value: "does_not_expire"

claimed_reward.reward.expiry_options.seconds

null

required

claimed_reward.reward.redeemable_expiry_options

null

required

claimed_reward.reward.supported_channels

enum<string>[]

required

Available options:

web,

pos,

mobile

claimed_reward.reward.kind

string

required

Allowed value: "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

required

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

Show child attributes

claimed_reward.session.kind

enum<string>

required

Available options:

cart,

checkout,

custom

claimed_reward.session.token

string

required

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

required

deprecated

Deprecated in favour of auto_refund_at

remote_resource_deleted

boolean

required

Indicates if the redeemable resource associated with this reward was also deleted from the remote system. This will only be true if LoyaltyLion manages the resource. For example, when refunding a voucher-based reward with a Shopify store LoyaltyLion will also delete the voucher in Shopify

Redeem Reward List Transactions

⌘I

Admin API

Resources

Webhooks

Authorizations

Path Parameters

Response