Buy a reward
Management
This method allows buying a specific Reward by Member.
With error 'No coupons left' returned when reward cannot be bought because of lack of coupons. With error 'Not enough points' returned when reward cannot be bought because of not enough points on customer account. With empty error returned when reward limits exceeded. An optional shippingAddress ships this redemption to an address other than the member's profile address. It is stored on the issued reward only and shown in the redemption details; the member's profile is not changed. Without it, the issued reward keeps the member's profile address. For a fortune wheel the address is stored on the issued fortune wheel only; the reward won with /draw keeps the member's profile address. A member buying a reward that is not visible to them gets 404.
Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/
Obtain an access token
Send a request with the parameters username and password
Definition
POST /api/admin/login_check Go to definition
Example
curl {HOST}/api/admin/login_check
-H 'Content-Type: application/json;charset=UTF-8'
-H 'Accept: application/json, text/plain, */*'
--data-binary '{"username":"admin","password":"password"}'
Example Response
{
"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
"refresh_token":"0558f8bb29948c4e54c443f..."
}
Using JSON Web Token
Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.
Example
curl {HOST}/api/{storeCode}/analytics/members
-H 'Accept: application/json'
-H 'Content-type: application/x-www-form-urlencoded'
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'
Refresh JSON Web Token
You can refresh token using refresh_token that was given during login.
To refresh admin token POST /api/token/refresh Go to definition
Store code
Reward ID
Return created reward ID.
Created reward identity
00000000-0000-0000-0000-000000000000Bad request.
Unauthorized
Forbidden.
Not found.
Service Unavailable — a concurrency lock protecting this operation could not be acquired in time. The request lost a race with a concurrent request for the same resource (for example the same member) and was rolled back without any side effects. Nothing about the submitted payload is wrong: the request may be retried, ideally after a short backoff. The response body deliberately carries only the generic status text — the internal lock key is never exposed.
POST /api/{storeCode}/reward/{reward}/buy HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 303
{
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 1,
"couponValue": 1,
"dateValid": "2026-01-01T00:00:00.000Z",
"withoutPoints": true,
"rewardWalletCode": "text",
"shippingAddress": {
"street": "text",
"address1": "text",
"address2": "text",
"province": "text",
"city": "text",
"postal": "text",
"country": "JP"
}
}[
{
"issuedRewardId": "00000000-0000-0000-0000-000000000000"
}
]Last updated
Was this helpful?

