Get redeemed rewards list

Integration This method returns a list of all redeemed rewards in the system. If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

get

Authorizations

AuthorizationstringRequired

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
POST /api/{storeCode}/member/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.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

Query parameters

_pageinteger · min: 1Optional

Number of page with results, starts from 1

Default: 1Example: 1

_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page

Default: 10Example: 25

_scrollstringOptional

To use scroll pagination, add the _scroll parameter to your query: ?_scroll

To retrieve the next page, take the scroll value from the previous response and use it in the next request: ?_scroll=eyJjcmVhdGVkQXQiOiIyMDI1LTA3LTAxIDEzOjU2OjI5LjAyMTcwMyIsImlkIjoiNTM5N2RiYzYtZGVkMi00MTQ0LTlhMjQtOTRjYmI5YWVjNDBjIn0=

Notes:

• Scroll pagination does not support sorting with _orderBy.
• Items are returned in ascending order by the createdAt field by default.

rewardIdstringOptional

namestringOptional

tokenstringOptional

statusstringOptional

costInPointsintegerOptional

rewardTypestringOptional

redemptionDatestring · date-timeOptional

cancelledAtstring · date-timeOptional

fortuneWheelStatus:drawnAtstring · date-timeOptional

Fortune Wheel draw date, use the [hasValue] / [notHasValue] key to get only drawn / not drawn redemptions

customerIdstringOptional

customerData:emailstringOptional

customerData:firstNamestringOptional

customerData:lastNamestringOptional

customerData:phonestringOptional

customerData:loyaltyCardNumberstringOptional

actionCause:transactionIdstringOptional

Transaction id related to

actionCause:campaignIdstringOptional

Campaign id related to

actionCause:customEventIdstringOptional

Custom event id related to

actionCause:internalEventNamestringOptional

Internal event name related to

reward:labelsstringOptional

Labels using pattern e.g. (key1;value1),(key2;value2),...

reward:categoriesstring · uuidOptional

Responses

200

List of Issued Reward

application/json

or

or

or

or

or

or

or

or

or

400

Bad request.

application/json

403

Forbidden.

application/json

get/api/{storeCode}/redemption

GET /api/{storeCode}/redemption HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "rewardId": "123e4567-e89b-12d3-a456-426614174000",
      "issuedRewardId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "tax": 1,
      "taxPriceValue": 1,
      "price": 1,
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "redemptionDate": "2026-01-01T00:00:00.000Z",
      "issuedCoupon": {
        "code": "text",
        "value": 1,
        "activeFrom": "2026-01-01T00:00:00.000Z",
        "activeTo": "2026-01-01T00:00:00.000Z",
        "usedAt": "2026-01-01T00:00:00.000Z"
      },
      "customerData": {
        "email": "text",
        "firstName": "text",
        "lastName": "text",
        "phone": "text",
        "loyaltyCardNumber": "text",
        "address": {}
      },
      "costInPoints": 1,
      "token": "text",
      "rewardType": "static_coupon",
      "actionCause": {
        "campaignId": "123e4567-e89b-12d3-a456-426614174000",
        "customerId": "123e4567-e89b-12d3-a456-426614174000",
        "transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "customEventId": "123e4567-e89b-12d3-a456-426614174000",
        "internalEventName": "text",
        "performedAt": "2026-01-01T00:00:00.000Z",
        "rewardId": "123e4567-e89b-12d3-a456-426614174000",
        "issuedRewardId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "cancelledAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}