Reward

These endpoints allow you to easily manage rewards.

Buy a reward

post

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.

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

rewardstring · uuidRequired

Reward ID

Body

application/json

or

or

or

Responses

200

Return created reward ID.

application/json

issuedRewardIdstringOptional

Created reward identity

Example: 00000000-0000-0000-0000-000000000000

400

Bad request.

application/json

post/api/{storeCode}/reward/{reward}/buy

HTTPcURLJavaScriptPython

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

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1,
  "couponValue": 1,
  "dateValid": "2026-07-18T16:39:35.178Z",
  "withoutPoints": true,
  "rewardWalletCode": "text"
}

[
  {
    "issuedRewardId": "00000000-0000-0000-0000-000000000000"
  }
]

Remove coupon code

delete

Management This method allows removing a specific coupon from the specific Reward.

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

rewardstring · uuidRequired

Reward ID

couponCodestringRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/reward/{reward}/coupon/{couponCode}

HTTPcURLJavaScriptPython

DELETE /api/{storeCode}/reward/{reward}/coupon/{couponCode} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get reward’s coupons list

get

Management This method returns coupons related to a specific Reward. If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

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

rewardstring · uuidRequired

Reward ID

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

codestringOptional

issuedbooleanOptional

Responses

200

Returned when successful

application/json

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/reward/{reward}/coupon

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "code": "text",
      "issued": true
    }
  ]
}

Deprecated

Add coupon list to the reward

post

Management This method allows adding coupons to the specific Reward.

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

rewardstring · uuidRequired

Reward ID

Body

application/json

couponsstring[]Optional

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/reward/{reward}/coupon

HTTPcURLJavaScriptPython

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

{
  "coupons": [
    "text"
  ]
}

No content

Get redeemed reward’s details

get

Management This method returns detailed information about a specific Reward.

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

rewardstring · uuidRequired

Reward ID

Responses

200

Returned when successful

application/json

rewardstringOptional

namestringOptional

levelsstring · uuid[]Optional

segmentsstring · uuid[]Optional

categoriesstring · uuid[]Optional

brandIconbooleanOptional

rewardIdstring · uuidOptional

targetstring · enumOptionalPossible values:

activebooleanOptional

costInPointsnumberOptional

taxnumberOptional

taxPriceValuenumberOptional

pricenumberOptional

featuredbooleanOptional

publicbooleanOptional

photosobject[]Optional

createdAtstring · date-timeOptional

notIssuedCouponsnumberOptional

fulfillmentTrackingbooleanOptionalDeprecated

couponValuenumberOptional

usageLeftnumberOptionalDeprecated

usageLeftForCustomernumberOptionalDeprecated

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/reward/{reward}

HTTPcURLJavaScriptPython

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

{
  "reward": "text",
  "name": "text",
  "levels": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "segments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "brandIcon": true,
  "rewardId": "123e4567-e89b-12d3-a456-426614174000",
  "target": "level",
  "active": true,
  "costInPoints": 1,
  "activity": {
    "allTime": true
  },
  "visibility": {
    "allTime": true
  },
  "tax": 1,
  "taxPriceValue": 1,
  "price": 1,
  "labels": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "featured": true,
  "public": true,
  "photos": [
    {}
  ],
  "createdAt": "2026-07-18T16:39:35.178Z",
  "usageLimit": {
    "general": 1,
    "perUser": 1
  },
  "notIssuedCoupons": 1,
  "limitUsages": {
    "general": {
      "interval": {
        "type": "calendarHours"
      },
      "currentValue": 1,
      "limitValue": 1
    },
    "perMember": {
      "interval": {
        "type": "calendarHours"
      },
      "currentValue": 1,
      "limitValue": 1
    }
  },
  "translations": [
    {
      "name": "text",
      "id": 1,
      "locale": "text"
    }
  ],
  "couponGenerator": {
    "length": 1,
    "characterSet": "text"
  },
  "couponValue": 1,
  "segmentNames": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "levelNames": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "categoryNames": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "unitsConversion": {
    "ratio": 1,
    "rounding": "up"
  },
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "fortuneWheel": {
    "rules": [
      {
        "name": "text",
        "description": "text",
        "effects": [
          {
            "effect": "give_reward",
            "rewardId": "6a861f8a-6906-4002-8b9c-4db407e810ea",
            "couponValueRule": "23"
          }
        ],
        "chance": 0.5
      }
    ],
    "limits": {
      "points": {
        "interval": {
          "type": "days"
        },
        "value": 1
      },
      "pointsPerMember": {
        "interval": {
          "type": "days"
        },
        "value": 1
      },
      "executionsPerMember": {
        "interval": {
          "type": "days"
        },
        "value": 1
      }
    }
  }
}

Update reward configuration

put

Management This method allows updating data on a specific Reward.

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

rewardstring · uuidRequired

Reward ID

Body

application/json

rewardany ofRequired

or

or

or

or

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

put/api/{storeCode}/reward/{reward}

HTTPcURLJavaScriptPython

PUT /api/{storeCode}/reward/{reward} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "reward": {
    "translations": {
      "en": {
        "name": "My Reward"
      }
    },
    "activity": {
      "allTime": true
    },
    "visibility": {
      "allTime": true
    }
  }
}

No content

Get rewards list

get

Integration This method returns a list of all Rewards existing 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.

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

_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

rewardIdstring · uuidOptional

rewardstring · enumOptionalDeprecatedPossible values:

activebooleanOptionalExample: true

createdAtstring · date-timeOptional

publicbooleanOptionalExample: true

fulfillmentTrackingbooleanOptionalDeprecatedExample: true

featuredbooleanOptionalExample: true

namestringOptional

shortDescriptionstringOptional

brandNamestringOptional

brandDescriptionstringOptional

levelsstringOptional

segmentsstringOptional

categoriesstringOptional

labelsstringOptional

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

costInPointsintegerOptional

limitintegerOptional

availablebooleanOptionalExample: true

visiblebooleanOptionalExample: true

visibleFromstring · date-timeOptional

visibleTostring · date-timeOptional

activeFromstring · date-timeOptional

activeTostring · date-timeOptional

formatstring · html|rawOptional

If set to html, the descriptions will be in HTML format. Omit for raw output.

typestring · enumOptional

Examples: - type[notIn]=material - type[in]=dynamic_coupon

Possible values:

Responses

200

Get all rewards.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/reward

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "reward": "text",
      "name": "text",
      "levels": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "segments": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "brandIcon": true,
      "rewardId": "123e4567-e89b-12d3-a456-426614174000",
      "target": "level",
      "active": true,
      "costInPoints": 1,
      "activity": {
        "allTime": true
      },
      "visibility": {
        "allTime": true
      },
      "tax": 1,
      "taxPriceValue": 1,
      "price": 1,
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "featured": true,
      "public": true,
      "photos": [
        {}
      ],
      "createdAt": "2026-07-18T16:39:35.178Z",
      "usageLimit": {
        "general": 1,
        "perUser": 1
      },
      "notIssuedCoupons": 1,
      "limitUsages": {
        "general": {
          "interval": {
            "type": "calendarHours"
          },
          "currentValue": 1,
          "limitValue": 1
        },
        "perMember": {
          "interval": {
            "type": "calendarHours"
          },
          "currentValue": 1,
          "limitValue": 1
        }
      },
      "translations": [
        {
          "name": "text",
          "id": 1,
          "locale": "text"
        }
      ],
      "couponGenerator": {
        "length": 1,
        "characterSet": "text"
      },
      "couponValue": 1,
      "segmentNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "levelNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "categoryNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "unitsConversion": {
        "ratio": 1,
        "rounding": "up"
      },
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ]
}

Add a reward

post

Management This method allows creating a new Reward in the system.

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

Body

application/json

rewardany ofRequired

or

or

or

or

Responses

200

Return created reward ID.

application/json

rewardIdstring · uuidRequired

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/reward

HTTPcURLJavaScriptPython

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

{
  "reward": {
    "reward": "static_coupon",
    "translations": {
      "en": {
        "name": "text",
        "shortDescription": "text",
        "usageInstruction": "text",
        "conditionsDescription": "text",
        "brandDescription": "text",
        "brandName": "text"
      }
    },
    "categories": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tax": 23,
    "price": 200,
    "taxPriceValue": 46,
    "active": true,
    "target": "level",
    "levels": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "segments": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "activity": {
      "allTime": true,
      "from": "2026-07-18T16:39:35.178Z",
      "to": "2026-07-18T16:39:35.178Z"
    },
    "visibility": {
      "allTime": true,
      "from": "2026-07-18T16:39:35.178Z",
      "to": "2026-07-18T16:39:35.178Z"
    },
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "featured": true,
    "public": true,
    "costInPoints": 60.8,
    "sourceWalletTypeCode": "text",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "limits": {
      "general": {
        "interval": {
          "type": "calendarHours"
        },
        "value": 1
      },
      "perMember": {
        "interval": {
          "type": "calendarHours"
        },
        "value": 1
      }
    },
    "usageLimit": {
      "perUser": 1,
      "general": 1
    },
    "fulfillmentTracking": true
  }
}

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

Deprecated

Get eligible members list

get

Integration This method returns for which Member this Reward is visible. If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

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

rewardstring · uuidRequired

Reward ID

Query parameters

pageintegerOptional

Page number

perPageintegerOptional

Number of elements per page

sortstringOptional

Field to sort by

directionstring · asc|descOptional

Sorting direction

visiblebooleanOptional

Responses

200

Get all rewards.

application/json

403

Forbidden.

application/json

get/api/{storeCode}/reward/{reward}/members

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "registeredAt": "2026-07-18T16:39:35.178Z",
      "active": true,
      "channelId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "text",
      "lastName": "text",
      "gender": "text",
      "email": "text",
      "phone": "text",
      "birthDate": "2026-07-18T16:39:35.178Z",
      "lastLevelRecalculation": "2026-07-18T16:39:35.178Z",
      "address": {
        "street": "text",
        "address1": "text",
        "address2": "text",
        "province": "text",
        "city": "text",
        "postal": "text",
        "country": "text"
      },
      "loyaltyCardNumber": "text",
      "createdAt": "2026-07-18T16:39:35.178Z",
      "updatedAt": "2026-07-18T16:39:35.178Z",
      "agreement1": true,
      "agreement2": true,
      "agreement3": true,
      "company": {
        "name": "text",
        "nip": "text"
      },
      "transactionsCount": 1,
      "returnTransactionsCount": 1,
      "transactionsAmount": 1,
      "returnTransactionsAmount": 1,
      "transactionsAmountWithoutDeliveryCosts": 1,
      "amountExcludedForLevel": 1,
      "averageTransactionAmount": 1,
      "averageReturnTransactionAmount": 1,
      "lastTransactionDate": "2026-07-18T16:39:35.178Z",
      "firstTransactionDate": "2026-07-18T16:39:35.178Z",
      "levelAchievementDate": "2026-07-18T16:39:35.178Z",
      "anonymized": true,
      "referralToken": "text",
      "defaultAccount": {
        "accountId": "text",
        "activePoints": 1,
        "transferredPoints": 1,
        "lockedPoints": 1,
        "expiredPoints": 1,
        "spentPoints": 1,
        "earnedPoints": 1,
        "blockedPoints": 1
      },
      "customFieldsData": [
        {
          "customFieldSchemaId": "123e4567-e89b-12d3-a456-426614174000",
          "customFieldName": "text",
          "customFieldType": "text",
          "value": "text"
        }
      ]
    }
  ]
}

Activate a reward

post

Management This method allows activating a specific Reward.

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

rewardstring · uuidRequired

Reward ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/reward/{reward}/activate

HTTPcURLJavaScriptPython

POST /api/{storeCode}/reward/{reward}/activate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deactivate a reward

post

Management This method allows deactivating a specific Reward.

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

rewardstring · uuidRequired

Reward ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/reward/{reward}/deactivate

HTTPcURLJavaScriptPython

POST /api/{storeCode}/reward/{reward}/deactivate HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get redeemed reward's details

get

Integration This method returns detailed information about a specific redeemed reward.

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

issuedRewardstring · uuidRequired

IssuedReward ID

Query parameters

formatstring · html|rawOptional

If set to html, the descriptions will be in HTML format. Omit for raw output.

Responses

200

Returned when successful

application/json

or

or

or

or

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/redemption/{issuedReward}

HTTPcURLJavaScriptPython

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

{
  "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-07-18T16:39:35.178Z",
  "issuedCoupon": {
    "code": "text",
    "value": 1,
    "activeFrom": "2026-07-18T16:39:35.178Z",
    "activeTo": "2026-07-18T16:39:35.178Z",
    "usedAt": "2026-07-18T16:39:35.178Z"
  },
  "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-07-18T16:39:35.178Z",
    "rewardId": "123e4567-e89b-12d3-a456-426614174000",
    "issuedRewardId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "cancelledAt": "2026-07-18T16:39:35.178Z"
}

Get redeemed rewards list

get

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.

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

_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

HTTPcURLJavaScriptPython

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-07-18T16:39:35.178Z",
      "issuedCoupon": {
        "code": "text",
        "value": 1,
        "activeFrom": "2026-07-18T16:39:35.178Z",
        "activeTo": "2026-07-18T16:39:35.178Z",
        "usedAt": "2026-07-18T16:39:35.178Z"
      },
      "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-07-18T16:39:35.178Z",
        "rewardId": "123e4567-e89b-12d3-a456-426614174000",
        "issuedRewardId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "cancelledAt": "2026-07-18T16:39:35.178Z"
    }
  ]
}

Change redeemed reward’s status change history

get

Management This method returns a Reward redemption's status change history. If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an _orderBy parameter in query.

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

issuedRewardstring · uuidRequired

IssuedReward ID

Responses

200

Returned when successful

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/redemption/{issuedReward}/status/history

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "status": "text",
      "comment": "text",
      "updatedAt": "2026-07-18T16:39:35.178Z"
    }
  ]
}

Get reward's image

get

Integration This method returns a photo added to a specific Reward.

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

rewardstring · uuidRequired

Reward ID

photoIdstringRequired

Responses

200

Returned when successful

image/*

string · binaryOptional

302

Redirect to presigned URL when presigned URLs are enabled.

404

Not found.

application/json

get/api/{storeCode}/reward/{reward}/photo/{photoId}

HTTPcURLJavaScriptPython

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

binary

Delete reward’s image

delete

Management This method allows removing a photo added to a specific Reward.

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

rewardstring · uuidRequired

Reward ID

photoIdstringRequired

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

delete/api/{storeCode}/reward/{reward}/photo/{photoId}

HTTPcURLJavaScriptPython

DELETE /api/{storeCode}/reward/{reward}/photo/{photoId} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add an image to the reward

post

Management This method allows adding a photo to a specific Reward.

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

rewardstring · uuidRequired

Reward ID

Body

application/json

Responses

204

Success. No content.

No content

400

Bad request.

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/reward/{reward}/photo

HTTPcURLJavaScriptPython

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

{
  "photo": {
    "file": {}
  }
}

No content

Change redeemed reward’s status

post

Management This method allows changing a Reward redemption status.

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

issuedRewardstring · uuidRequired

IssuedReward ID

Body

application/json

statusstring · enumOptional

Current status of the redemeed reward. By default, all rewards are redeemed with issued status.

Possible values:

commentstringOptional

Comment related to the status change (optional).

Responses

204

Success. No content.

No content

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/redemption/{issuedReward}/status

HTTPcURLJavaScriptPython

POST /api/{storeCode}/redemption/{issuedReward}/status HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "status": "issued",
  "comment": "text"
}

No content

Cancel redeemed reward

post

Management This method allows cancelling a Reward redemption.

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

issuedRewardstring · uuidRequired

IssuedReward ID

Responses

204

Success. No content.

No content

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

post/api/{storeCode}/redemption/{issuedReward}/cancel

HTTPcURLJavaScriptPython

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

No content

Draw a reward from the fortune wheel

post

Integration This method executes the draw of the reward from the fortune wheel and returns the result.

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

issuedRewardstring · uuidRequired

IssuedReward ID

Responses

200

Draw result details

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

409

Conflict — the resource is already being processed by another concurrent request.

application/json

post/api/{storeCode}/redemption/{issuedReward}/draw

HTTPcURLJavaScriptPython

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

{
  "fortuneWheelStatus": {
    "drawnAt": "2026-07-18T16:39:35.178Z",
    "ruleName": "text",
    "effects": [
      {
        "type": "unit",
        "status": {
          "code": "success",
          "message": "text"
        },
        "transfer": {
          "transferId": "123e4567-e89b-12d3-a456-426614174000",
          "walletCode": "text",
          "units": 1
        }
      }
    ]
  }
}

Get available rewards to a member list

get

Integration This method returns a list of all Rewards existing 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.

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

memberstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|email=[a-zA-Z0-9!#$%&'\.*+\-@=?^_`{|}~;]+|phone=[0-9+]+|loyaltyCardNumber=[0-9a-zA-Z\._-]+

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

rewardIdstring · uuidOptional

rewardstring · enumOptionalPossible values:

activebooleanOptionalExample: true

createdAtstring · date-timeOptional

publicbooleanOptionalExample: true

fulfillmentTrackingbooleanOptionalDeprecatedExample: true

featuredbooleanOptionalExample: true

namestringOptional

shortDescriptionstringOptional

brandNamestringOptional

brandDescriptionstringOptional

levelsstringOptional

segmentsstringOptional

categoriesstringOptional

labelsstringOptional

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

costInPointsintegerOptional

limitintegerOptional

availablebooleanOptional

Filters out active rewards by active field and also by activity dates from and to.

Example: true

visiblebooleanOptionalExample: true

visibleFromstring · date-timeOptional

visibleTostring · date-timeOptional

activeFromstring · date-timeOptional

activeTostring · date-timeOptional

formatstring · html|rawOptional

If set to html, the descriptions will be in HTML format. Omit for raw output.

Responses

200

Get all rewards available for logged in member.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/member/{member}/reward

HTTPcURLJavaScriptPython

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

{
  "items": [
    {
      "reward": "text",
      "name": "text",
      "levels": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "segments": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "brandIcon": true,
      "rewardId": "123e4567-e89b-12d3-a456-426614174000",
      "target": "level",
      "active": true,
      "costInPoints": 1,
      "activity": {
        "allTime": true
      },
      "visibility": {
        "allTime": true
      },
      "tax": 1,
      "taxPriceValue": 1,
      "price": 1,
      "labels": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "featured": true,
      "public": true,
      "photos": [
        {}
      ],
      "createdAt": "2026-07-18T16:39:35.178Z",
      "notIssuedCoupons": 1,
      "limitUsages": {
        "general": {
          "interval": {
            "type": "calendarHours"
          },
          "currentValue": 1,
          "limitValue": 1
        },
        "perMember": {
          "interval": {
            "type": "calendarHours"
          },
          "currentValue": 1,
          "limitValue": 1
        }
      },
      "translations": [
        {
          "name": "text",
          "id": 1,
          "locale": "text"
        }
      ],
      "couponGenerator": {
        "length": 1,
        "characterSet": "text"
      },
      "couponValue": 1,
      "segmentNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "levelNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "categoryNames": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "unitsConversion": {
        "ratio": 1,
        "rounding": "up"
      }
    }
  ]
}