Error
A valid request URL is required to generate request examples{
"id": "cust-1",
"name": "Camille Renard",
"email": "camille.renard@example.com",
"phone": "06 12 34 56 78",
"tier": "Or",
"postalCode": "75011",
"points": 1240,
"spend": 842.5,
"orders": 17,
"optIn": true
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Customers
Get a customer by id
Returns one customer’s full record (identity, contact, loyalty tier/points, lifetime spend and the marketing optIn flag). Use it to confirm who you are about to act on before any write. 404s when no customer carries the id.
GET
/
v1
/
customers
/
{id}
Error
A valid request URL is required to generate request examples{
"id": "cust-1",
"name": "Camille Renard",
"email": "camille.renard@example.com",
"phone": "06 12 34 56 78",
"tier": "Or",
"postalCode": "75011",
"points": 1240,
"spend": 842.5,
"orders": 17,
"optIn": true
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
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
The customer id to act on, e.g. cust-1 (client Customer.id).
Minimum string length:
1Response
The customer record.
The customer record.
Minimum string length:
1Minimum string length:
1Minimum string length:
1Required range:
0 <= x <= 9007199254740991Required range:
x >= 0Required range:
0 <= x <= 9007199254740991Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$