loyalty

Embed

<a href="https://hermeticor.com/docs/ref-loyalty"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/c47a3b2d-9cb6-4aa8-8a09-6a1cefb21e33/social-card.svg?v=3e7ae33eec8b" alt="loyalty" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/loyalty/programs/{id}/tiers

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/loyalty/programs/{id}/tiers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "programId": "string",
      "name": "string",
      "threshold": 0,
      "multiplierPct": 0,
      "benefits": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem232[]required

Show child parameters

idstringrequired

programIdstringrequired

namestringrequired

thresholdintegerrequired

multiplierPctintegerrequired

benefitsstring[]required

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

POSThttps://hermeticor.com/v1/loyalty/programs/{id}/tiers

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

thresholdintegerrequired

multiplierPctinteger

= 100

benefitsstring[]

= []

{
  "name": "string",
  "threshold": 0,
  "multiplierPct": 100,
  "benefits": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/loyalty/programs/{id}/tiers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","threshold":0,"multiplierPct":100,"benefits":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "programId": "string",
  "name": "string",
  "threshold": 0,
  "multiplierPct": 0,
  "benefits": [
    "string"
  ]
}

Schema

idstringrequired

programIdstringrequired

namestringrequired

thresholdintegerrequired

multiplierPctintegerrequired

benefitsstring[]required

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

DELETEhttps://hermeticor.com/v1/loyalty/programs/{id}/tiers/{subId}

Parameters

idstringpathrequired

subIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/loyalty/programs/{id}/tiers/{subId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

PATCHhttps://hermeticor.com/v1/loyalty/programs/{id}/tiers/{subId}

Parameters

idstringpathrequired

subIdstringpathrequired

Request body

application/json

namestring

thresholdinteger

multiplierPctinteger

benefitsstring[]

{
  "name": "string",
  "threshold": 0,
  "multiplierPct": 0,
  "benefits": [
    "string"
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/loyalty/programs/{id}/tiers/{subId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","threshold":0,"multiplierPct":0,"benefits":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/loyalty/programs/{id}/tiers

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

GEThttps://hermeticor.com/v1/loyalty/programs/{id}/rewards

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/loyalty/programs/{id}/rewards" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "programId": "string",
      "name": "string",
      "description": "string",
      "cost": 0,
      "poolId": "string",
      "enabled": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem233[]required

Show child parameters

idstringrequired

programIdstringrequired

namestringrequired

descriptionstringrequired

costintegerrequired

poolIdstringrequired

enabledbooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

POSThttps://hermeticor.com/v1/loyalty/programs/{id}/rewards

A reward costs points and hands out a code from a coupon pool

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

descriptionstring

costintegerrequired

poolIdstringrequired

enabledboolean

= true

{
  "name": "string",
  "description": "string",
  "cost": 0,
  "poolId": "string",
  "enabled": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/loyalty/programs/{id}/rewards" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","cost":0,"poolId":"string","enabled":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "programId": "string",
  "name": "string",
  "description": "string",
  "cost": 0,
  "poolId": "string",
  "enabled": true
}

Schema

idstringrequired

programIdstringrequired

namestringrequired

descriptionstringrequired

costintegerrequired

poolIdstringrequired

enabledbooleanrequired

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

DELETEhttps://hermeticor.com/v1/loyalty/programs/{id}/rewards/{subId}

Parameters

idstringpathrequired

subIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/loyalty/programs/{id}/rewards/{subId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/loyalty/programs/{id}/tiers/{subId}

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

PATCHhttps://hermeticor.com/v1/loyalty/programs/{id}/rewards/{subId}

Parameters

idstringpathrequired

subIdstringpathrequired

Request body

application/json

namestring

descriptionstring

costinteger

poolIdstring

enabledboolean

{
  "name": "string",
  "description": "string",
  "cost": 0,
  "poolId": "string",
  "enabled": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/loyalty/programs/{id}/rewards/{subId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","cost":0,"poolId":"string","enabled":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/loyalty/programs/{id}/rewards

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

GEThttps://hermeticor.com/v1/loyalty/programs/{id}/members

Parameters

limitintegerquery

= 50

cursorstringquery

tierIdstringquery

minBalanceintegerquery

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/loyalty/programs/{id}/members" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "programId": "string",
      "profileId": "string",
      "balance": 0,
      "lifetimePoints": 0,
      "tierId": "string",
      "tierName": "string",
      "expiringSoon": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem234[]required

Show child parameters

programIdstringrequired

profileIdstringrequired

balanceintegerrequired

lifetimePointsintegerrequired

tierIdstringrequired

tierNamestringrequired

expiringSoonintegerrequired

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

5XX Default Response

Same as 4XX · GET /v1/loyalty/programs/{id}/tiers

Next part

Updated Nov 8, 2026

Was this page helpful?