u
This commit is contained in:
56
docs/api/routes/v1/customer.md
Normal file
56
docs/api/routes/v1/customer.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# `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 | Unix timestamp cursor of last customer sync |
|
||||
| `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`._
|
||||
40
docs/api/routes/v1/customergroup.md
Normal file
40
docs/api/routes/v1/customergroup.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# `GET /v1/customergroup`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
JTL-POS customer group synchronization
|
||||
|
||||
Returns customer groups modified after lastChangedCustomerGroup cursor for the authenticated POS register, excluding 'Lieferanten'.
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `lastChangedCustomerGroup` | no | string | Unix timestamp cursor of last customer group sync |
|
||||
| `limit` | no | integer | Maximum number of customer groups to return |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Array of customer group objects for JTL-POS
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"customerGroupId": "1",
|
||||
"name": "Endkunden",
|
||||
"standard": "1",
|
||||
"discountPercent": "0.000000",
|
||||
"lastChanged": "1721000000"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Unauthorized |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user