Bulk Action

These endpoints will allow you to easily manage bulk actions in system.

Create bulk action

post

Management

Authorizations

Bearertoken

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

typestring · enumRequired

Bulk Action Type

Possible values:

Body

application/json

or

or

or

Responses

200Success

application/json

bulkActionIdstring · uuidRequired

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/bulkAction/{type}

HTTPcURLJavaScriptPython

POST /api/{storeCode}/bulkAction/{type} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 993

{
  "cancelTransfers": {
    "requestedAt": "2026-07-18T12:16:13.990Z",
    "criteria": {
      "pending": true,
      "createdAt": "2026-07-18T12:16:13.990Z",
      "transferId": "123e4567-e89b-12d3-a456-426614174000",
      "walletId": "123e4567-e89b-12d3-a456-426614174000",
      "type": "adding",
      "value": 1,
      "comment": "text",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "registeredOn": "2026-07-18T12:16:13.990Z",
      "lockedUntil": "2026-07-18T12:16:13.990Z",
      "expiresAt": "2026-07-18T12:16:13.990Z",
      "cancelled": true,
      "actionCause:transactionId": "123e4567-e89b-12d3-a456-426614174000",
      "actionCause:customerId": "123e4567-e89b-12d3-a456-426614174000",
      "actionCause:campaignId": "123e4567-e89b-12d3-a456-426614174000",
      "actionCause:customerEventId": "123e4567-e89b-12d3-a456-426614174000",
      "actionCause:internalEventName": "123e4567-e89b-12d3-a456-426614174000",
      "actionCause:campaignName": "text",
      "walletType:code": "text",
      "member:id": "123e4567-e89b-12d3-a456-426614174000",
      "member:email": "text",
      "member:phoneNumber": "text",
      "member:loyaltyCardNumber": "text"
    }
  }
}

{
  "bulkActionId": "123e4567-e89b-12d3-a456-426614174000"
}

Get bulk actions

get

Management

Authorizations

Bearertoken

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

typestring · enumOptional

Bulk Action Type

Possible values:

requestedAtstring · date-timeOptional

Date and time when the action was requested by admin

_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

Responses

200Success

application/json

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/bulkAction

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "bulkActionId": "123e4567-e89b-12d3-a456-426614174000",
      "requestedAt": "2026-07-18T12:16:13.990Z",
      "criteria": {
        "pending": true,
        "createdAt": "2026-07-18T12:16:13.990Z",
        "transferId": "123e4567-e89b-12d3-a456-426614174000",
        "walletId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "adding",
        "value": 1,
        "comment": "text",
        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
        "registeredOn": "2026-07-18T12:16:13.990Z",
        "lockedUntil": "2026-07-18T12:16:13.990Z",
        "expiresAt": "2026-07-18T12:16:13.990Z",
        "cancelled": true,
        "actionCause:transactionId": "123e4567-e89b-12d3-a456-426614174000",
        "actionCause:customerId": "123e4567-e89b-12d3-a456-426614174000",
        "actionCause:campaignId": "123e4567-e89b-12d3-a456-426614174000",
        "actionCause:customerEventId": "123e4567-e89b-12d3-a456-426614174000",
        "actionCause:internalEventName": "123e4567-e89b-12d3-a456-426614174000",
        "actionCause:campaignName": "text",
        "walletType:code": "text",
        "member:id": "123e4567-e89b-12d3-a456-426614174000",
        "member:email": "text",
        "member:phoneNumber": "text",
        "member:loyaltyCardNumber": "text"
      },
      "resource": "text",
      "type": "cancelTransfers",
      "processedRowCount": 1,
      "message": "text",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "text",
      "comment": "text"
    }
  ]
}

Get bulk action items

get

Management

Authorizations

Bearertoken

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

bulkActionIdstring · uuidRequired

Query parameters

objectToProcessIdstring · uuidOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

statusstring · enumOptionalPossible values:

_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

Responses

200Success

application/json

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/bulkAction/{bulkActionId}/item

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "bulkActionItemId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-07-18T12:16:13.990Z",
      "updatedAt": "2026-07-18T12:16:13.990Z",
      "status": "queued",
      "type": "cancelTransfers",
      "objectToProcessId": "text",
      "message": "text"
    }
  ]
}