u
This commit is contained in:
38
docs/api/routes/v1/deletedentity.md
Normal file
38
docs/api/routes/v1/deletedentity.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# `GET /v1/deletedentity`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
JTL-POS deleted entity synchronization
|
||||
|
||||
Returns deleted entities after lastChangedDeletedEntity cursor for the authenticated POS register.
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `lastChangedDeletedEntity` | no | string | Sequential ID cursor of last processed tombstone |
|
||||
| `limit` | no | integer | Maximum number of deleted entities to return |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Array of deleted entity objects for JTL-POS
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"entityId": "123",
|
||||
"entityType": 1,
|
||||
"lastChanged": 45
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## 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