u
This commit is contained in:
@@ -278,7 +278,9 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/pos/client.md`](routes/pos/client.md) | `GET /v1/client` |
|
||||
| [`routes/v1/customer.md`](routes/v1/customer.md) | `GET /v1/customer` |
|
||||
| [`routes/v1/customergroup.md`](routes/v1/customergroup.md) | `GET /v1/customergroup` |
|
||||
| [`routes/v1/deletedentity.md`](routes/v1/deletedentity.md) | `GET /v1/deletedentity` |
|
||||
| [`routes/pos/init.md`](routes/pos/init.md) | `GET /v1/init` |
|
||||
| [`routes/v1/order.md`](routes/v1/order.md) | `POST /v1/order` |
|
||||
| [`routes/pos/pimage.md`](routes/pos/pimage.md) | `GET /v1/pimage` |
|
||||
| [`routes/v1/product.md`](routes/v1/product.md) | `GET /v1/product` |
|
||||
| [`routes/vfs/list.md`](routes/vfs/list.md) | `GET /vfs` |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview (All)
|
||||
|
||||
Overview of all 266 API endpoints across all modules.
|
||||
Overview of all 268 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -933,9 +933,15 @@ _none_
|
||||
#### JTL-POS customer group synchronization — `GET /v1/customergroup`
|
||||
- Params: `query: lastChangedCustomerGroup?: str, limit?: int`
|
||||
- Returns: `200 { customerGroupId: str, name: str, standard: str, discountPercent: str, lastChanged: str }[]`
|
||||
#### JTL-POS deleted entity synchronization — `GET /v1/deletedentity`
|
||||
- Params: `query: lastChangedDeletedEntity?: str, limit?: int`
|
||||
- Returns: `200 { entityId: str, entityType: int, lastChanged: int }[]`
|
||||
#### POS sync initialization counts — `GET /v1/init`
|
||||
- Params: `query: lastChangedProduct?: int, lastChangedCategory?: int, lastChangedCustomer?: int, lastChangedCustomerGroup?: int, lastChangedCompositeProduct?: int, lastChangedDeletedEntity?: int`
|
||||
- Returns: `200 { version: str, product_count: str, category_count: str, customer_count: str, customerGroup_count: str, compositeProduct_count: str, configurationGroup_count: str, configurationItem_count: str, deletedEntity_count: str, max_orderId_count: str }`
|
||||
#### JTL-POS order upload — `POST /v1/order`
|
||||
- Params: `query: mandantId?: str, body: { orders?: {}[] }`
|
||||
- Returns: `200 { status: str, externalOrderId: str, message: str }[]`
|
||||
#### POS product image delivery — `GET /v1/pimage`
|
||||
- Params: `query: path: str, w?: int, h?: int, format?: str`
|
||||
- Returns: `200 jpeg`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview
|
||||
|
||||
Overview of all 187 API endpoints across all modules.
|
||||
Overview of all 189 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -662,6 +662,15 @@ _none_
|
||||
- Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
|
||||
- Returns: `200 { unit: T19 }`
|
||||
|
||||
### Section: /v1
|
||||
|
||||
#### JTL-POS deleted entity synchronization — `GET /v1/deletedentity`
|
||||
- Params: `query: lastChangedDeletedEntity?: str, limit?: int`
|
||||
- Returns: `200 { entityId: str, entityType: int, lastChanged: int }[]`
|
||||
#### JTL-POS order upload — `POST /v1/order`
|
||||
- Params: `query: mandantId?: str, body: { orders?: {}[] }`
|
||||
- Returns: `200 { status: str, externalOrderId: str, message: str }[]`
|
||||
|
||||
### Section: /warehouse
|
||||
|
||||
#### List warehouses — `GET /warehouse`
|
||||
|
||||
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`._
|
||||
52
docs/api/routes/v1/order.md
Normal file
52
docs/api/routes/v1/order.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# `POST /v1/order`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
JTL-POS order upload
|
||||
|
||||
Imports orders from JTL-POS, creating order manifests, payments, and shipments with stock deductions.
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `mandantId` | no | string | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
| Field | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `orders` | no | object[] | |
|
||||
|
||||
```json
|
||||
{
|
||||
"orders": [
|
||||
{}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Array of sync results per order
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"status": "OK",
|
||||
"externalOrderId": "2",
|
||||
"message": ""
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 401 | Unauthorized |
|
||||
| 500 | Internal server error |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user