Error

A valid request URL is required to generate request examples

{
  "status": "deactivated",
  "deactivatedAt": "2026-08-04T09:12:00.000Z"
}

{
  "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
  }
}

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

Customers

Deactivate a customer (reversible)

Takes one customer OUT OF CIRCULATION without changing a single field of their data. They stop appearing in the till picker, customer search, clienteling and segmentation, while their name, contact details, loyalty balance and entire purchase history stay intact and still resolve by id — so every past sale keeps rendering the buyer it was made to. Fully reversible with reactivateCustomer. THIS IS NOT AN ERASURE: it removes nobody’s personal data and must never be used to answer a GDPR erasure request — use eraseCustomerData for that. Idempotent. 409 when the customer has already been anonymized (that standing is terminal, so there is nothing left to take out of circulation), 404 for an unknown id.

POST

/

v1

/

customers

/

{id}

/

deactivation

Error

A valid request URL is required to generate request examples

{
  "status": "deactivated",
  "deactivatedAt": "2026-08-04T09:12:00.000Z"
}

{
  "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
  }
}

{
  "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

id

string

required

The customer id to act on, e.g. cust-1 (client Customer.id).

Minimum string length: 1

Response

The new standing: deactivated, stamped with the instant it took effect.

The new standing: deactivated, stamped with the instant it took effect.

status

enum<string>

required

Available options:

active,

deactivated,

anonymized

deactivatedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

anonymizedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$