Loyalty Programs API

Lets a loyalty platform read the retail stores that take part in a SnowBee loyalty program — for example to show a member where their program is honoured.

This guide assumes you have read Get started.

What you need

A Client ID and Client Secret for an API client with loyalty_programs:read permission and the loyalty programs selected
Your Tenant ID
The Loyalty Program ID — used in each endpoint URL

Request the token with scope: "loyalty_programs:read" and omit resource. One token can access every loyalty program selected on the client. Endpoints live under:

https://api.snowbee.no/v1/tenants/TENANT_ID/loyalty_programs/LOYALTY_PROGRAM_ID/

The API currently exposes reads only, so there is no loyalty-program write scope. A request requires loyalty_programs:read and a Loyalty Program ID included in the token's loyalty_program_ids claim; missing permission or an unselected program returns 403. This scope can share a token with Core, eCom and demand-planning scopes. The legacy single-program token request remains supported; see Get started.

Endpoints

Endpoint	Description
`GET /retail_stores`	Retail stores in the loyalty program. Only stores with status `RELEASED` are included.

Example

Reference: GET /retail_stores.

curl "https://api.snowbee.no/v1/tenants/TENANT_ID/loyalty_programs/LOYALTY_PROGRAM_ID/retail_stores" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "retailStores": [
    {
      "id": "019c1234-5678-7abc-8def-123456789012",
      "number": "1001",
      "name": "Bjørklund Storo",
      "email": "storo@example.com",
      "phone": "+4712345678",
      "webAddress": "https://example.com/storo",
      "addresses": [ { "...": "see the API Reference" } ]
    }
  ]
}

The list is complete (no pagination) and changes rarely; cache it and refresh a few times a day. A 404 means the loyalty program does not exist for this tenant.

Next steps

API Reference — field-level documentation, tag Loyalty Programs