u
This commit is contained in:
49
docs/api/routes/pos/init.md
Normal file
49
docs/api/routes/pos/init.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# `GET /v1/init`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
POS sync initialization counts
|
||||
|
||||
Returns entity change counts since the provided `lastChanged*` unix timestamp cursors
|
||||
for the authenticated POS terminal (`Authorization: Bearer <authToken>`).
|
||||
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `lastChangedProduct` | no | integer | Unix timestamp of last synced product update |
|
||||
| `lastChangedCategory` | no | integer | Unix timestamp of last synced category update |
|
||||
| `lastChangedCustomer` | no | integer | Unix timestamp of last synced customer update |
|
||||
| `lastChangedCustomerGroup` | no | integer | Unix timestamp of last synced customer group update |
|
||||
| `lastChangedCompositeProduct` | no | integer | Unix timestamp of last synced composite product update |
|
||||
| `lastChangedDeletedEntity` | no | integer | Unix timestamp of last synced deleted entity |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Sync initialization counts
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "1.10.12.0",
|
||||
"product_count": "19",
|
||||
"category_count": "4",
|
||||
"customer_count": "0",
|
||||
"customerGroup_count": "1",
|
||||
"compositeProduct_count": "0",
|
||||
"configurationGroup_count": "0",
|
||||
"configurationItem_count": "0",
|
||||
"deletedEntity_count": "0",
|
||||
"max_orderId_count": "0"
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Missing or invalid POS Authorization token |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user