For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get units transfers list

Management This method returns a list of all Point transfers that have been created 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

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

Path parameters
storeCodestringRequired

Store code

Query parameters
transferIdstring · uuidOptional

Transfer id

accountIdstring · uuidOptionalDeprecated

Owner account id

walletIdstring · uuidOptional

Owner wallet id

typestringOptional

Type

valuenumberOptional

Value

commentstringOptional

Comment

createdBystringOptional

Creator

cancelledbooleanOptional

cancelled

pendingbooleanOptional

pending

createdAtstring · date-timeOptional

createdAt

registeredOnstring · date-timeOptional

registeredOn

lockedUntilstring · date-timeOptional

lockedUntil

expiresAtstring · date-timeOptional

expiresAt

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

walletType:codestringOptional

Wallet type code related to

member:idstring · uuidOptional

Member indentifier related to

member:emailstring · emailOptional

Member email related to

member:phoneNumberstringOptional

Member phone number related to

member:loyaltyCardNumberstringOptional

Member loyalty card number related to

_scrollstringOptional

Scroll (cursor) pagination: the recommended way to fetch all records or any large volume of them. Unlike with _page, the cost of a request does not grow with how far into the result it is, see Scroll mechanism for pages.

  1. Send the first request with an empty _scroll parameter: ?_scroll.
  2. Send the next request with the scroll.next value from the previous response: ?_scroll=<scroll.next>. Keep the other query parameters unchanged.
  3. Stop when the response has no scroll.next value: the last response has an empty items list. You can stop earlier when a response has fewer items than _itemsOnPage.

Notes:

  • Items are always returned in descending order of createdAt, then of their id. _orderBy has no effect (its values are still validated).
  • _page has no effect (it must still be a valid page number). _itemsOnPage sets the number of items in one response.
  • Filters work the same way as in _page pagination.
  • A scroll response has no total.
_itemsOnPageinteger · min: 1 · max: 50Optional

Items on one page, in both _page and _scroll pagination.

Default: 10Example: 25
_pageinteger · min: 1Optional

Number of the page with results, starts from 1.

Not for iterating over large data sets. The cost of a request grows with the page number: the database still reads and discards every row of the previous pages, so deep pages are slow and load the whole API. Use _page to browse the first pages of a result. The maximum value of _page is limited on some endpoints, see Limits.

To fetch all records, or any large volume of them, use the _scroll parameter where the endpoint offers it, see Scroll mechanism for pages.

Default: 1Example: 1
Responses
200

List of transfers

application/json
or
get/api/{storeCode}/points
GET /api/{storeCode}/points HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "items": [
    {
      "transferId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "accountId": "text",
      "lockedUntil": "2026-01-01T00:00:00.000Z",
      "expiresAt": "2026-01-01T00:00:00.000Z",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "comment": "text",
      "cancelled": true,
      "pending": true,
      "unlockedAt": "2026-01-01T00:00:00.000Z",
      "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": "text",
        "issuedRewardId": "text"
      },
      "value": 1,
      "externalTransferId": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "walletType": {
        "name": "text",
        "code": "text",
        "unitSingularName": "text",
        "unitPluralName": "text"
      },
      "member": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phoneNumber": "text",
        "loyaltyCardNumber": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ]
}

Last updated

Was this helpful?