LOloyaltylion
customers

POST /v2/customers/{merchant_id}/claimed_rewards

Changed on

Request

  • Base URL
    https://api.loyaltylion.com
  • URL
    https://api.loyaltylion.com/v2/customers/{merchant_id}/claimed_rewards
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

merchant_idstring required

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

Request body

reward_idnumber required

The ID of the reward to claim

multipliernumber

The number of times to claim this reward in a single request. Only supported for store_fulfilment custom rewards, where it must be a whole number, and for checkout redemption rewards, where it is the discount amount and must be between the reward's minimum and maximum redemption amounts, and one of its fixed redemption amounts when it has them. Other rewards reject any multiplier other than 1.

variant_idstring

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

shopify_action_idstring
attribution'redemption_notification'

Response

201

Example response

{
  "claimed_reward": {
    "redeemable": {
      "currency": "usd"
    }
  }
}

Changes

  • 69cbd7bf7128Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      removed 'propertyNames' constraint from the /// response property for the status

    • breaking

      removed 'propertyNames' constraint from the /// response property for the status

    • warning

      the request property's exclusiveMinimum was set to 0.00

    • warning

      added the new draft_order enum value to the /// response property for the response status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added active_subscription_discount_voucher product_cart cart_discount_voucher checkout_redemption collection_discount_voucher custom free_shipping_voucher gift_card product_discount_voucher subscription_buy_with_points discriminator mapping keys to the / response property for the response status

    • info

      added cost quantity discriminator mapping keys to the //// response property for the response status

    • info

      added fulfilment pos_action product product_grant gift_card voucher tiktok_coupon discriminator mapping keys to the / response property for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status