Files
dashback/docs/api/routes/v1/customer.md
2026-10-27 06:48:30 +00:00

57 lines
1.3 KiB
Markdown

# `GET /v1/customer`
Protected. Requires a valid session cookie (`credentials: 'include'`).
JTL-POS customer catalog synchronization
Returns customer list modified after lastChangedCustomer cursor for the authenticated POS register.
## Query parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `lastChangedCustomer` | no | string | Sequential ID cursor of last synced customer entry (`posterminalsyncqueue.id`) |
| `limit` | no | integer | Maximum number of customers to return |
## Response `200`
Array of customer objects for JTL-POS
```json
[
{
"id": "…",
"customerNumber": "…",
"firstname": "…",
"lastname": "…",
"title": "…",
"company": "…",
"address": "…",
"addressSupplement": "…",
"city": "…",
"postalCode": "…",
"state": "…",
"country": "…",
"phone": "…",
"email": "…",
"customerGroupId": "…",
"salutation": "…",
"birthday": "…",
"discount": "…",
"taxIdNumber": "…",
"lastChanged": "…",
"debtorNumber": "…"
}
]
```
## Errors
| Status | Description |
|--------|-------------|
| 401 | Unauthorized |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._