Authorizations
Authorization string header required Bearer authentication header of the formBearer <token>, where <token> is your REST API token.
Request Body
customer_id string required The platform customer ID (e.g. Shopify customer ID) Example:"9049402769586"
reward_id
string<uuid>
required
The UUID of the reward to redeem. Obtain this from the rewards[].id field in the Get redeemable rewards response.
Example:
"90424fa7-e8a9-4ef4-b43a-72c9b2028db5"
Response
201 - application/json data object Hide child attributes data.coupon_code string | null The generated coupon or discount code to apply at checkout.null for store credit rewards.
Example:
"YUKO-TVJ-BL1"
data.points_spent
integer
The number of points deducted from the customer’s balance.
Example:
500
data.reward_type
enum<string> | null
The type of reward that was redeemed.
Available options:
fixed_discount,
percentage_discount,
free_shipping,
free_product,
store_credit
Example:
"fixed_discount"
data.discount_value
number | null
The discount amount or percentage associated with the coupon. null for free shipping and free product rewards.
Example:
5
data.expires_at
string<date-time> | null
The expiry date of the generated coupon. null if the reward has no expiry.
Example:
"2026-06-01T00:00:00+00:00"