Error

A valid request URL is required to generate request examples

{
  "customerId": "cust-1",
  "balance": 1240,
  "lifetimePoints": 1820,
  "tier": {
    "id": "or",
    "name": "Or",
    "minLifetimePoints": 1000
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Loyalty

Get a customer's derived loyalty account (fidélité, palier)

Recomputes a CUSTOMER’s loyalty standing from the ledger: the balance redeemable right now (expiry-aware when the program config sets an expiry policy), the monotonic lifetimePoints, and the tier those lifetime points resolve to under the active program. This is the authoritative number to quote before a redemption — the directory row from listLoyaltyMembers is a read model. 404s when the customer has no ledger entry at all (never enrolled or never earned).

GET

loyalty

accounts

{customerId}

Error

A valid request URL is required to generate request examples

{
  "customerId": "cust-1",
  "balance": 1240,
  "lifetimePoints": 1820,
  "tier": {
    "id": "or",
    "name": "Or",
    "minLifetimePoints": 1000
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Authorizations

Authorization

string

header

required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Path Parameters

customerId

string

required

The customer id whose derived loyalty account to read (client Customer.id).

Minimum string length: 1

Response

The derived account: live balance, lifetime points and resolved tier.

customerId

string

required

balance

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

lifetimePoints

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

tier

object

required

Show child attributes

List loyalty members (fidélité)Accrue loyalty points for a sale (points de fidélité)

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

Get a customer's derived loyalty account (fidélité, palier)

Authorizations

Path Parameters

Response