u
This commit is contained in:
@@ -4,7 +4,7 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Set Stückliste (bundle items) for an article
|
||||
|
||||
Configures the article as a Stückliste covering a list of count * article. An article that is a father or has options cannot be a Stückliste. Pass an empty array to remove the Stückliste.
|
||||
Configures the article as a Stückliste covering a list of count * article. A father article cannot be a Stückliste. Can be combined with options. Pass an empty array to remove the Stückliste.
|
||||
|
||||
## Path parameters
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Set options list for an article
|
||||
|
||||
Configures options for an article. Some options can be mandated (come with the article in any case). An article that is a father or a Stückliste cannot have options. Pass an empty array to remove options.
|
||||
Configures options for an article. Some options can be mandated (come with the article in any case). A father article cannot have options. Can be combined with a Stückliste. Pass an empty array to remove options.
|
||||
|
||||
## Path parameters
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Articles in category
|
||||
|
||||
Returns articles in a category the user is authorized for.
|
||||
Returns articles in a category the user is authorized for (omits child articles of a father article). Each article includes `childCount` (the number of its child articles).
|
||||
|
||||
## Path parameters
|
||||
|
||||
@@ -19,7 +19,23 @@ Articles list
|
||||
```json
|
||||
{
|
||||
"articles": [
|
||||
{}
|
||||
{
|
||||
"id": 1,
|
||||
"sku": "…",
|
||||
"name": "…",
|
||||
"slug": "…",
|
||||
"net": 1,
|
||||
"taxRate": 1,
|
||||
"track_stock": true,
|
||||
"optionsCount": 1,
|
||||
"articleListCount": 1,
|
||||
"childCount": 1,
|
||||
"fullHash": "…",
|
||||
"thumbW": 1,
|
||||
"thumbH": 1,
|
||||
"thumbHash": "…",
|
||||
"brand": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
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