Sign in

v1

latestOpenAPI 3.1.12026-07-222968170.1 KB
customers

post/v2/customers/{merchant_id}/claimed_rewards

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; voucher-method rewards reject a multiplier greater than 1, as each claim requires a unique code.

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"
    }
  }
}