u
This commit is contained in:
seb
@@ -1,454 +1,482 @@
|
||||
# Dash API Routes Overview
|
||||
|
||||
Overview of all 145 API endpoints across all modules.
|
||||
Overview of all 144 API endpoints across all modules.
|
||||
|
||||
### Parameter Notation
|
||||
### Notation
|
||||
|
||||
- **Every value carries its type** — `string`, `integer`, `number`, `boolean`, `object`, arrays as `type[]`.
|
||||
- **Required parameters** have no `?` (e.g. `sku: string`, `id: integer`, `query: si: string`, `body: { name: string }`).
|
||||
- **Optional parameters** are marked with `?` (e.g. `query: limit?: integer`, `body: { sort?: integer }`, `body?: { … }`).
|
||||
- **Path parameters** match `{param}` in the route URL.
|
||||
- **Query parameters** are prefixed with `query: ...`.
|
||||
- **Request bodies** are prefixed with `body: ...` (or `body?: ...` if the whole body is optional).
|
||||
- **Response objects** use the same notation, so `201 { article: { … } }` means a JSON object with an `article` property.
|
||||
Types: `str` string, `int` integer, `num` number, `bool` boolean, `obj` object; `T[]` array; `?` optional.
|
||||
Params: path values first, then `query:` and `body:` (`body?` = optional body). Responses: status code + JSON shape; `Tn` refers to a reusable type below.
|
||||
|
||||
### Reusable types
|
||||
|
||||
- `T1` = `{ article: T2 }`
|
||||
- `T2` = `{ id: int, sku: str, name: str, slug: str, track_stock: bool, unitamount: num, weight: num, unit: obj, brand: obj, categoryIds: int[], photos: T17[], eans: str[], prices: T25[], suppliers: T9[] }`
|
||||
- `T3` = `{ delivery: T4 }`
|
||||
- `T4` = `{ id: int, number: str, type: str, supplierId: int, externalNumber: str, date: str, createdAt: str, ledger: T29, lines: T18[], files: T8[] }`
|
||||
- `T5` = `{ order: T7 }`
|
||||
- `T6` = `{ quote: T7 }`
|
||||
- `T7` = `{ id: int, number: str, type: str, entityId: int, date: str, createdAt: str, lines: T18[] }`
|
||||
- `T8` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created: str, modified: str, thumbavif: str, thumbx: int, thumby: int, meta: obj }`
|
||||
- `T9` = `{ id: int, articleId: int, entityId: int, supplierName: str, sku: str, pu: num, stock: num, sort: int, priceId: int, price: T32 }`
|
||||
- `T10` = `{ ledger: T11[] }`
|
||||
- `T11` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash: str, sku: str, created_at: str }`
|
||||
- `T12` = `{ id: int, entityId: int, firstName: str, name: str, street: str, streetNumber: str, zip: str, city: str, county: str, addressType: str }`
|
||||
- `T13` = `{ id: int, name: str, sort: int, exclusive: bool, values: T27[] }`
|
||||
- `T14` = `{ entity: T19 }`
|
||||
- `T15` = `{ printer: T20 }`
|
||||
- `T16` = `{ labeltemplate: T22 }`
|
||||
- `T17` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }`
|
||||
- `T18` = `{ id: int, sku: str, name: str, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str }`
|
||||
- `T19` = `{ id: int, customergroupId: int, firstName: str, name: str, number: str, createdAt: str, updatedAt: str }`
|
||||
- `T20` = `{ id: int, company_id: int, address: str, type: str, model: str, serial: str, sort: int, desc: str }`
|
||||
- `T21` = `{ amount: num, net: num, taxrate: num, sku?: str, name?: str, pu?: num, rebate?: num, comment?: str }`
|
||||
- `T22` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: obj, thumb: str }`
|
||||
- `T23` = `{ article: T24 }`
|
||||
- `T24` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }`
|
||||
- `T25` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }`
|
||||
- `T26` = `{ id: int, entityId: int, contactType: str, contact: str }`
|
||||
- `T27` = `{ id: int, attributeId: int, value: str, sort: int }`
|
||||
- `T28` = `{ id: int, name: str, createdAt: str, updatedAt: str }`
|
||||
- `T29` = `{ totalPositions: int, completelyOnLedgerPositions: int }`
|
||||
- `T30` = `{ id: int, name: str, sort: int, exclusive: bool }`
|
||||
- `T31` = `{ warehouse: T33 }`
|
||||
- `T32` = `{ net: num, taxId: int, taxRate: num }`
|
||||
- `T33` = `{ id: int, name: str, sort: int }`
|
||||
|
||||
### Routes
|
||||
|
||||
#### Create article in category — `POST /article`
|
||||
- Params: `body: { categoryId: integer, name: string, track_stock?: boolean }`
|
||||
- Returns: `201 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean } }`
|
||||
- Params: `body: { categoryId: int, name: str, track_stock?: bool }`
|
||||
- Returns: `201 T23`
|
||||
#### Delete article by SKU — `DELETE /article/{sku}`
|
||||
- Params: `sku: string, query: cascade?: boolean`
|
||||
- Params: `sku: str, query: cascade?: bool`
|
||||
- Returns: `204 void`
|
||||
#### Get article by SKU — `GET /article/{sku}`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 T1`
|
||||
#### Update article by SKU — `PATCH /article/{sku}`
|
||||
- Params: `sku: string, body: { name?: string, unitamount?: number, unitSi?: string, track_stock?: boolean }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str, body: { name?: str, unitamount?: num, unitSi?: str, track_stock?: bool }`
|
||||
- Returns: `200 T1`
|
||||
#### Get Stückliste (bundle items) for an article — `GET /article/{sku}/articlelist`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { items: { id: integer, articleId: integer, sku: string, name: string, count: integer, sort: integer }[] }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { items: { id: int, articleId: int, sku: str, name: str, count: int, sort: int }[] }`
|
||||
#### Set Stückliste (bundle items) for an article — `PUT /article/{sku}/articlelist`
|
||||
- Params: `sku: string, body: { items: { articleId?: integer, sku?: string, count?: integer, sort?: integer }[] }`
|
||||
- Returns: `200 { items: object[] }`
|
||||
- Params: `sku: str, body: { items: { articleId?: int, sku?: str, count?: int, sort?: int }[] }`
|
||||
- Returns: `200 { items: obj[] }`
|
||||
#### List article attribute values — `GET /article/{sku}/attributevalue`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { attributevalues: { id: integer, articleId: integer, attributeId: integer, attributeName: string, exclusive: boolean, attributeValueId: integer, value: string, sort: integer }[] }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { attributevalues: { id: int, articleId: int, attributeId: int, attributeName: str, exclusive: bool, attributeValueId: int, value: str, sort: int }[] }`
|
||||
#### Bulk set article attribute values — `PUT /article/{sku}/attributevalue`
|
||||
- Params: `sku: string, body: integer[]`
|
||||
- Returns: `200 { attributevalues: { id: integer, articleId: integer, attributeId: integer, attributeName: string, exclusive: boolean, attributeValueId: integer, value: string, sort: integer }[] }`
|
||||
- Params: `sku: str, body: int[]`
|
||||
- Returns: `200 { attributevalues: { id: int, articleId: int, attributeId: int, attributeName: str, exclusive: bool, attributeValueId: int, value: str, sort: int }[] }`
|
||||
#### Set or clear article brand by SKU — `PUT /article/{sku}/brand`
|
||||
- Params: `sku: string, body: { brandId: integer }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str, body: { brandId: int }`
|
||||
- Returns: `200 T1`
|
||||
#### Replace article categories by SKU — `PUT /article/{sku}/categories`
|
||||
- Params: `sku: string, body: { categoryIds: integer[] }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str, body: { categoryIds: int[] }`
|
||||
- Returns: `200 T1`
|
||||
#### List child articles of a parent article — `GET /article/{sku}/children`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { children: { id: integer, sku: string, name: string, parentsort: integer, attributeValueId: integer, attributeValue: string }[] }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }`
|
||||
#### Create and attach a new child article to a parent article — `POST /article/{sku}/children`
|
||||
- Params: `sku: string, body: { attributeValueId?: integer, value?: string, name?: string }`
|
||||
- Returns: `201 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean } }`
|
||||
- Params: `sku: str, body: { attributeValueId?: int, value?: str, name?: str }`
|
||||
- Returns: `201 T23`
|
||||
#### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children`
|
||||
- Params: `sku: string, body: { sku: string, attributeValueId?: integer, value?: string, reparent?: boolean }`
|
||||
- Returns: `200 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean }, children: object[] }`
|
||||
- Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }`
|
||||
- Returns: `200 { article: T24, children: obj[] }`
|
||||
#### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}`
|
||||
- Params: `sku: string, childSku: string, query: deleteArticle?: boolean`
|
||||
- Returns: `200 { success: boolean, deleted: boolean }`
|
||||
- Params: `sku: str, childSku: str, query: deleteArticle?: bool`
|
||||
- Returns: `200 { success: bool, deleted: bool }`
|
||||
#### Replace article EANs by SKU — `PUT /article/{sku}/eans`
|
||||
- Params: `sku: string, body: { eans: string[] }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str, body: { eans: str[] }`
|
||||
- Returns: `200 T1`
|
||||
#### Get article history by SKU — `GET /article/{sku}/history`
|
||||
- Params: `sku: string, query: limit?: integer`
|
||||
- Returns: `200 { history: { id: integer, date: string, text: string }[], truncated: boolean }`
|
||||
- Params: `sku: str, query: limit?: int`
|
||||
- Returns: `200 { history: { id: int, date: str, text: str }[], truncated: bool }`
|
||||
#### Delete article image — `DELETE /article/{sku}/image/{fullHash}`
|
||||
- Params: `sku: string, fullHash: string`
|
||||
- Params: `sku: str, fullHash: str`
|
||||
- Returns: `204 void`
|
||||
#### Reorder article images — `PUT /article/{sku}/images/order`
|
||||
- Params: `sku: string, body: { fullHashes: string[] }`
|
||||
- Returns: `200 { fullHashes: string[] }`
|
||||
- Params: `sku: str, body: { fullHashes: str[] }`
|
||||
- Returns: `200 { fullHashes: str[] }`
|
||||
#### Get options list for an article — `GET /article/{sku}/optionslist`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { options: { id: integer, articleId: integer, sku: string, name: string, count: integer, sort: integer, mandated: boolean }[] }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { options: { id: int, articleId: int, sku: str, name: str, count: int, sort: int, mandated: bool }[] }`
|
||||
#### Set options list for an article — `PUT /article/{sku}/optionslist`
|
||||
- Params: `sku: string, body: { options: { articleId?: integer, sku?: string, count?: integer, sort?: integer, mandated?: boolean }[] }`
|
||||
- Returns: `200 { options: object[] }`
|
||||
- Params: `sku: str, body: { options: { articleId?: int, sku?: str, count?: int, sort?: int, mandated?: bool }[] }`
|
||||
- Returns: `200 { options: obj[] }`
|
||||
#### Toggle parent mode for an article — `POST /article/{sku}/parent`
|
||||
- Params: `sku: string, body: { isParent: boolean, attributeNameId?: integer }`
|
||||
- Returns: `200 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean } }`
|
||||
- Params: `sku: str, body: { isParent: bool, attributeNameId?: int }`
|
||||
- Returns: `200 T23`
|
||||
#### Replace POS prices by SKU — `PUT /article/{sku}/prices`
|
||||
- Params: `sku: string, body: { prices: { price: number, tax: number, minmultiplier?: number }[] }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str, body: { prices: { price: num, tax: num, minmultiplier?: num }[] }`
|
||||
- Returns: `200 T1`
|
||||
#### Print article label — `POST /article/{sku}/print`
|
||||
- Params: `sku: string, body: { templateId: integer, printerId: integer, quantity: integer }`
|
||||
- Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }`
|
||||
- Returns: `200`
|
||||
#### List article properties — `GET /article/{sku}/property`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { properties: { id: integer, articleId: integer, propertyId: integer, name: string, exclusive: boolean, value: string, sort: integer }[] }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { properties: { id: int, articleId: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int }[] }`
|
||||
#### Bulk set article properties — `PUT /article/{sku}/property`
|
||||
- Params: `sku: string, body: { properties: { propertyId: integer, value: string, sort?: integer }[] }`
|
||||
- Returns: `200 { properties: { id: integer, articleId: integer, propertyId: integer, name: string, exclusive: boolean, value: string, sort: integer }[] }`
|
||||
- Params: `sku: str, body: { properties: { propertyId: int, value: str, sort?: int }[] }`
|
||||
- Returns: `200 { properties: { id: int, articleId: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int }[] }`
|
||||
#### Delete article property — `DELETE /article/{sku}/property/{propertyId}`
|
||||
- Params: `sku: string, propertyId: integer`
|
||||
- Params: `sku: str, propertyId: int`
|
||||
- Returns: `200`
|
||||
#### List article suppliers — `GET /article/{sku}/supplier`
|
||||
- Params: `sku: string`
|
||||
- Returns: `200 { suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] }`
|
||||
- Params: `sku: str`
|
||||
- Returns: `200 { suppliers: T9[] }`
|
||||
#### Assign supplier to article — `POST /article/{sku}/supplier`
|
||||
- Params: `sku: string, body: { entityId: integer, sku?: string, pu?: number, stock?: number, sort?: integer, netPrice?: number, taxId?: integer, taxRate?: number }`
|
||||
- Returns: `201 { supplier: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } } }`
|
||||
- Params: `sku: str, body: { entityId: int, sku?: str, pu?: num, stock?: num, sort?: int, netPrice?: num, taxId?: int, taxRate?: num }`
|
||||
- Returns: `201 { supplier: T9 }`
|
||||
#### Reorder article suppliers — `PUT /article/{sku}/supplier/order`
|
||||
- Params: `sku: string, body: { ids: integer[] }`
|
||||
- Returns: `200 { ids: integer[] }`
|
||||
- Params: `sku: str, body: { ids: int[] }`
|
||||
- Returns: `200 { ids: int[] }`
|
||||
#### Remove supplier assignment from article — `DELETE /article/{sku}/supplier/{id}`
|
||||
- Params: `sku: string, id: integer`
|
||||
- Params: `sku: str, id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update article supplier assignment — `PATCH /article/{sku}/supplier/{id}`
|
||||
- Params: `sku: string, id: integer, body: { sku?: string, pu?: number, stock?: number, sort?: integer, netPrice?: number, taxId?: integer, taxRate?: number }`
|
||||
- Returns: `200 { supplier: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } } }`
|
||||
- Params: `sku: str, id: int, body: { sku?: str, pu?: num, stock?: num, sort?: int, netPrice?: num, taxId?: int, taxRate?: num }`
|
||||
- Returns: `200 { supplier: T9 }`
|
||||
#### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock`
|
||||
- Params: `sku: string, body: { track_stock: boolean }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
- Params: `sku: str, body: { track_stock: bool }`
|
||||
- Returns: `200 T1`
|
||||
#### Set article weight by SKU — `PUT /article/{sku}/weight`
|
||||
- Params: `sku: string, body: { weight: number }`
|
||||
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
|
||||
#### List article search index — `GET /articleIndex`
|
||||
- Params: `query: windowSize: integer`
|
||||
- Returns: `200 { articles: { id: integer, sku: string, name: string, eans: string[], categoryIds: integer[] }[], truncated: boolean }`
|
||||
- Params: `sku: str, body: { weight: num }`
|
||||
- Returns: `200 T1`
|
||||
#### List attribute names — `GET /attributename`
|
||||
_none_
|
||||
- Returns: `200 { attributenames: { id: integer, name: string, sort: integer, exclusive: boolean, values: { id: integer, attributeId: integer, value: string, sort: integer }[] }[] }`
|
||||
- Returns: `200 { attributenames: T13[] }`
|
||||
#### Create attribute name — `POST /attributename`
|
||||
- Params: `body: { name: string, sort?: integer, exclusive?: boolean }`
|
||||
- Returns: `201 { attributename: { id: integer, name: string, sort: integer, exclusive: boolean, values: { id: integer, attributeId: integer, value: string, sort: integer }[] } }`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { attributename: T13 }`
|
||||
#### Reorder attribute names — `PUT /attributename/order`
|
||||
- Params: `body: { attributenameIds: integer[] }`
|
||||
- Params: `body: { attributenameIds: int[] }`
|
||||
- Returns: `200`
|
||||
#### List values for an attribute — `GET /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: integer`
|
||||
- Returns: `200 { values: { id: integer, attributeId: integer, value: string, sort: integer }[] }`
|
||||
- Params: `attributeId: int`
|
||||
- Returns: `200 { values: T27[] }`
|
||||
#### Create value for an attribute — `POST /attributename/{attributeId}/value`
|
||||
- Params: `attributeId: integer, body: { value: string, sort?: integer }`
|
||||
- Returns: `201 { attributevalue: { id: integer, attributeId: integer, value: string, sort: integer } }`
|
||||
- Params: `attributeId: int, body: { value: str, sort?: int }`
|
||||
- Returns: `201 { attributevalue: T27 }`
|
||||
#### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order`
|
||||
- Params: `attributeId: integer, body: { attributevalueIds: integer[] }`
|
||||
- Params: `attributeId: int, body: { attributevalueIds: int[] }`
|
||||
- Returns: `200`
|
||||
#### Delete attribute name — `DELETE /attributename/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `200`
|
||||
#### Update attribute name — `PATCH /attributename/{id}`
|
||||
- Params: `id: integer, body: { name?: string, sort?: integer, exclusive?: boolean }`
|
||||
- Returns: `200 { attributename: { id: integer, name: string, sort: integer, exclusive: boolean, values: { id: integer, attributeId: integer, value: string, sort: integer }[] } }`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `200 { attributename: T13 }`
|
||||
#### Delete attribute value — `DELETE /attributevalue/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `200`
|
||||
#### Update attribute value — `PATCH /attributevalue/{id}`
|
||||
- Params: `id: integer, body: { value?: string, sort?: integer }`
|
||||
- Returns: `200 { attributevalue: { id: integer, attributeId: integer, value: string, sort: integer } }`
|
||||
- Params: `id: int, body: { value?: str, sort?: int }`
|
||||
- Returns: `200 { attributevalue: T27 }`
|
||||
#### Login with Google ID token — `POST /auth/login`
|
||||
- Params: `body: { idToken: string }`
|
||||
- Returns: `200 { message: string, user: { id: integer, email: string, selectedCompanyId: integer, picture: string } }`
|
||||
- Params: `body: { idToken: str }`
|
||||
- Returns: `200 { message: str, user: { id: int, email: str, selectedCompanyId: int, picture: str } }`
|
||||
#### Logout — `POST /auth/logout`
|
||||
_none_
|
||||
- Returns: `200 { message: string }`
|
||||
- Returns: `200 { message: str }`
|
||||
#### List brands — `GET /brand`
|
||||
_none_
|
||||
- Returns: `200 { brands: { id: integer, name: string, gsprpinfo: string, pics: { id: integer, sort: integer, fullHash: string, thumbW: integer, thumbH: integer, thumbHash: string }[] }[] }`
|
||||
- Returns: `200 { brands: { id: int, name: str, gsprpinfo: str, pics: { id: int, sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[] }[] }`
|
||||
#### Upsert brand — `PUT /brand`
|
||||
- Params: `body: { name: string, gsprpinfo?: string }`
|
||||
- Returns: `200 { brand: { id: integer, name: string, gsprpinfo: string, pics: { id: integer, sort: integer, fullHash: string, thumbW: integer, thumbH: integer, thumbHash: string }[] } }`
|
||||
- Params: `body: { name: str, gsprpinfo?: str }`
|
||||
- Returns: `200 { brand: { id: int, name: str, gsprpinfo: str, pics: { id: int, sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[] } }`
|
||||
#### Delete brand — `DELETE /brand/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Create category — `POST /category`
|
||||
- Params: `body: { parentId: integer, name: string }`
|
||||
- Returns: `201 { category: { id: integer, parentId: integer, sort: integer, name: string } }`
|
||||
- Params: `body: { parentId: int, name: str }`
|
||||
- Returns: `201 { category: { id: int, parentId: int, sort: int, name: str } }`
|
||||
#### Reorder sibling categories — `PUT /category/order`
|
||||
- Params: `body: { parentId: integer, categoryIds: integer[] }`
|
||||
- Returns: `200 { categoryIds: integer[] }`
|
||||
- Params: `body: { parentId: int, categoryIds: int[] }`
|
||||
- Returns: `200 { categoryIds: int[] }`
|
||||
#### Category tree — `GET /category/tree`
|
||||
_none_
|
||||
- Returns: `200 { languageId: integer, tree: object[], articles: object[] }`
|
||||
- Returns: `200 { languageId: int, tree: obj[], articles: obj[] }`
|
||||
#### Delete category — `DELETE /category/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update category (rename or move) — `PATCH /category/{id}`
|
||||
- Params: `id: integer, body: { name?: string, parentId?: integer }`
|
||||
- Returns: `200 { category: { id: integer, name: string, slug: string, parentId: integer, sort: integer } }`
|
||||
- Params: `id: int, body: { name?: str, parentId?: int }`
|
||||
- Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }`
|
||||
#### Articles in category — `GET /category/{id}/articles`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { articles: { id: integer, sku: string, name: string, slug: string, net: number, taxRate: number, track_stock: boolean, optionsCount: integer, articleListCount: integer, childCount: integer, fullHash: string, thumbW: integer, thumbH: integer, thumbHash: string, brand: object }[] }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, net: num, taxRate: num, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, brand: obj }[] }`
|
||||
#### List category attribute values — `GET /category/{id}/attributevalue`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { attributevalues: { id: integer, categoryId: integer, attributeId: integer, attributeName: string, exclusive: boolean, attributeValueId: integer, value: string, sort: integer }[] }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { attributevalues: { id: int, categoryId: int, attributeId: int, attributeName: str, exclusive: bool, attributeValueId: int, value: str, sort: int }[] }`
|
||||
#### Bulk set category attribute values — `PUT /category/{id}/attributevalue`
|
||||
- Params: `id: integer, body: integer[]`
|
||||
- Returns: `200 { attributevalues: { id: integer, categoryId: integer, attributeId: integer, attributeName: string, exclusive: boolean, attributeValueId: integer, value: string, sort: integer }[] }`
|
||||
- Params: `id: int, body: int[]`
|
||||
- Returns: `200 { attributevalues: { id: int, categoryId: int, attributeId: int, attributeName: str, exclusive: bool, attributeValueId: int, value: str, sort: int }[] }`
|
||||
#### Delete category image — `DELETE /category/{id}/image`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { category: { id: integer, thumbW: integer, thumbH: integer, thumbHash: string } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { category: { id: int, thumbW: int, thumbH: int, thumbHash: str } }`
|
||||
#### List category properties — `GET /category/{id}/property`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { properties: { id: integer, categoryId: integer, propertyId: integer, name: string, exclusive: boolean, value: string, sort: integer }[] }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 { properties: { id: int, categoryId: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int }[] }`
|
||||
#### Bulk set category properties — `PUT /category/{id}/property`
|
||||
- Params: `id: integer, body: { properties: { propertyId: integer, value: string, sort?: integer }[] }`
|
||||
- Returns: `200 { properties: { id: integer, categoryId: integer, propertyId: integer, name: string, exclusive: boolean, value: string, sort: integer }[] }`
|
||||
- Params: `id: int, body: { properties: { propertyId: int, value: str, sort?: int }[] }`
|
||||
- Returns: `200 { properties: { id: int, categoryId: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int }[] }`
|
||||
#### Delete category property — `DELETE /category/{id}/property/{propertyId}`
|
||||
- Params: `id: integer, propertyId: integer`
|
||||
- Params: `id: int, propertyId: int`
|
||||
- Returns: `200`
|
||||
#### List companies — `GET /company`
|
||||
_none_
|
||||
- Returns: `200 { companies: { id: integer, iso639: string, name: string, taxrate: number, reducedtaxrate: number }[] }`
|
||||
- Returns: `200 { companies: { id: int, iso639: str, name: str, taxrate: num, reducedtaxrate: num }[] }`
|
||||
#### Get company history — `GET /company/history`
|
||||
- Params: `query: limit?: integer`
|
||||
- Returns: `200 { history: { id: integer, companyuserId: integer, date: string, text: string }[], truncated: boolean }`
|
||||
- Params: `query: limit?: int`
|
||||
- Returns: `200 { history: { id: int, companyuserId: int, date: str, text: str }[], truncated: bool }`
|
||||
#### Add company history entry — `POST /company/history`
|
||||
- Params: `body: { text: string }`
|
||||
- Returns: `201 { history: { id: integer, companyuserId: integer, date: string, text: string } }`
|
||||
- Params: `body: { text: str }`
|
||||
- Returns: `201 { history: { id: int, companyuserId: int, date: str, text: str } }`
|
||||
#### List company settings — `GET /company/setting`
|
||||
_none_
|
||||
- Returns: `200 { settings: { key: string, value: string }[] }`
|
||||
- Returns: `200 { settings: { key: str, value: str }[] }`
|
||||
#### Get company setting by key — `GET /company/setting/{key}`
|
||||
- Params: `key: string`
|
||||
- Returns: `200 { setting: { key: string, value: string } }`
|
||||
- Params: `key: str`
|
||||
- Returns: `200 { setting: { key: str, value: str } }`
|
||||
#### Upsert company setting — `PUT /company/setting/{key}`
|
||||
- Params: `key: string, body: { value: string, frontend?: boolean }`
|
||||
- Returns: `200 { setting: { key: string, value: string } }`
|
||||
- Params: `key: str, body: { value: str, frontend?: bool }`
|
||||
- Returns: `200 { setting: { key: str, value: str } }`
|
||||
#### Update company — `PUT /company/{id}`
|
||||
- Params: `id: integer, body: { iso639: string, name: string, taxrate: number, reducedtaxrate: number }`
|
||||
- Returns: `200 { company: { id: integer, iso639: string, name: string, taxrate: number, reducedtaxrate: number } }`
|
||||
- Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
|
||||
- Returns: `200 { company: { id: int, iso639: str, name: str, taxrate: num, reducedtaxrate: num } }`
|
||||
#### List customer groups — `GET /customergroup`
|
||||
_none_
|
||||
- Returns: `200 { customergroups: { id: integer, name: string, sort: integer, editable: boolean }[] }`
|
||||
- Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }`
|
||||
#### Create customer group — `POST /customergroup`
|
||||
- Params: `body: { name: string }`
|
||||
- Returns: `201 { customergroup: { id: integer, name: string, sort: integer } }`
|
||||
- Params: `body: { name: str }`
|
||||
- Returns: `201 { customergroup: T33 }`
|
||||
#### Reorder customer groups — `PUT /customergroup/order`
|
||||
- Params: `body: { customergroupIds: integer[] }`
|
||||
- Returns: `200 { customergroupIds: integer[] }`
|
||||
- Params: `body: { customergroupIds: int[] }`
|
||||
- Returns: `200 { customergroupIds: int[] }`
|
||||
#### Delete customer group — `DELETE /customergroup/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update customer group — `PATCH /customergroup/{id}`
|
||||
- Params: `id: integer, body: { name: string }`
|
||||
- Returns: `200 { customergroup: { id: integer, name: string, sort: integer } }`
|
||||
- Params: `id: int, body: { name: str }`
|
||||
- Returns: `200 { customergroup: T33 }`
|
||||
#### List deliveries — `GET /delivery`
|
||||
_none_
|
||||
- Returns: `200 { deliveries: { id: integer, number: string, type: string, supplierId: integer, externalNumber: string, date: string, createdAt: string, ledger: { totalPositions: integer, completelyOnLedgerPositions: integer } }[] }`
|
||||
- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, externalNumber: str, date: str, createdAt: str, ledger: T29 }[] }`
|
||||
#### Create delivery — `POST /delivery`
|
||||
- Params: `body: { externalNumber: string, date: string, lines: { amount: number, net: number, taxrate: number, sku?: string, name?: string, pu?: number, rebate?: number, comment?: string }[], supplierId?: integer, files?: { mimetype: string, name: string, content: string, sort?: integer, size?: integer, hash?: string, created?: string, modified?: string, meta?: object }[] }`
|
||||
- Returns: `201 { delivery: { id: integer, number: string, type: string, supplierId: integer, externalNumber: string, date: string, createdAt: string, ledger: { totalPositions: integer, completelyOnLedgerPositions: integer }, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[], files: { id: integer, manifestId: integer, fileId: integer, sort: integer, hash: string, mimetype: string, name: string, size: integer, created: string, modified: string, thumbavif: string, thumbx: integer, thumby: integer, meta: object }[] } }`
|
||||
- Params: `body: { externalNumber: str, date: str, lines: T21[], supplierId?: int, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: obj }[] }`
|
||||
- Returns: `201 T3`
|
||||
#### Delete delivery — `DELETE /delivery/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get delivery — `GET /delivery/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { delivery: { id: integer, number: string, type: string, supplierId: integer, externalNumber: string, date: string, createdAt: string, ledger: { totalPositions: integer, completelyOnLedgerPositions: integer }, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[], files: { id: integer, manifestId: integer, fileId: integer, sort: integer, hash: string, mimetype: string, name: string, size: integer, created: string, modified: string, thumbavif: string, thumbx: integer, thumby: integer, meta: object }[] } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T3`
|
||||
#### Update delivery — `PATCH /delivery/{id}`
|
||||
- Params: `id: integer, body: { externalNumber?: string, date?: string, supplierId?: integer, lines?: { amount: number, net: number, taxrate: number, sku?: string, name?: string, pu?: number, rebate?: number, comment?: string }[], files?: { mimetype: string, name: string, content: string, sort?: integer, size?: integer, hash?: string, created?: string, modified?: string, meta?: object }[] }`
|
||||
- Returns: `200 { delivery: { id: integer, number: string, type: string, supplierId: integer, externalNumber: string, date: string, createdAt: string, ledger: { totalPositions: integer, completelyOnLedgerPositions: integer }, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[], files: { id: integer, manifestId: integer, fileId: integer, sort: integer, hash: string, mimetype: string, name: string, size: integer, created: string, modified: string, thumbavif: string, thumbx: integer, thumby: integer, meta: object }[] } }`
|
||||
- Params: `id: int, body: { externalNumber?: str, date?: str, supplierId?: int, lines?: T21[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: obj }[] }`
|
||||
- Returns: `200 T3`
|
||||
#### Get delivery attachment file content — `GET /delivery/{id}/file/{fileId}`
|
||||
- Params: `id: integer, fileId: integer, query: download?: boolean`
|
||||
- Returns: `200 string`
|
||||
- Params: `id: int, fileId: int, query: download?: bool`
|
||||
- Returns: `200 str`
|
||||
#### List entities — `GET /entity`
|
||||
- Params: `query: customergroupId?: integer, role?: string`
|
||||
- Returns: `200 { entities: { id: integer, customergroupId: integer, firstName: string, name: string, number: string, createdAt: string, updatedAt: string }[] }`
|
||||
- Params: `query: customergroupId?: int, role?: str`
|
||||
- Returns: `200 { entities: T19[] }`
|
||||
#### Create entity — `POST /entity`
|
||||
- Params: `body: { customergroupId: integer, name: string, firstName?: string, number?: string }`
|
||||
- Returns: `201 { entity: { id: integer, customergroupId: integer, firstName: string, name: string, number: string, createdAt: string, updatedAt: string } }`
|
||||
- Params: `body: { customergroupId: int, name: str, firstName?: str, number?: str }`
|
||||
- Returns: `201 T14`
|
||||
#### Peek next customer number — `GET /entity/next-number`
|
||||
_none_
|
||||
- Returns: `200 { number: string }`
|
||||
- Returns: `200 { number: str }`
|
||||
#### List entity addresses — `GET /entity/{entityId}/address`
|
||||
- Params: `entityId: integer`
|
||||
- Returns: `200 { addresses: { id: integer, entityId: integer, firstName: string, name: string, street: string, streetNumber: string, zip: string, city: string, county: string, addressType: string }[] }`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { addresses: T12[] }`
|
||||
#### Create entity address — `POST /entity/{entityId}/address`
|
||||
- Params: `entityId: integer, body: { addressType: string, firstName?: string, name?: string, street?: string, streetNumber?: string, zip?: string, city?: string, county?: string }`
|
||||
- Returns: `201 { address: { id: integer, entityId: integer, firstName: string, name: string, street: string, streetNumber: string, zip: string, city: string, county: string, addressType: string } }`
|
||||
- Params: `entityId: int, body: { addressType: str, firstName?: str, name?: str, street?: str, streetNumber?: str, zip?: str, city?: str, county?: str }`
|
||||
- Returns: `201 { address: T12 }`
|
||||
#### Delete entity address — `DELETE /entity/{entityId}/address/{id}`
|
||||
- Params: `entityId: integer, id: integer`
|
||||
- Params: `entityId: int, id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update entity address — `PATCH /entity/{entityId}/address/{id}`
|
||||
- Params: `entityId: integer, id: integer, body: { addressType?: string, firstName?: string, name?: string, street?: string, streetNumber?: string, zip?: string, city?: string, county?: string }`
|
||||
- Returns: `200 { address: { id: integer, entityId: integer, firstName: string, name: string, street: string, streetNumber: string, zip: string, city: string, county: string, addressType: string } }`
|
||||
- Params: `entityId: int, id: int, body: { addressType?: str, firstName?: str, name?: str, street?: str, streetNumber?: str, zip?: str, city?: str, county?: str }`
|
||||
- Returns: `200 { address: T12 }`
|
||||
#### List entity contacts — `GET /entity/{entityId}/contact`
|
||||
- Params: `entityId: integer`
|
||||
- Returns: `200 { contacts: { id: integer, entityId: integer, contactType: string, contact: string }[] }`
|
||||
- Params: `entityId: int`
|
||||
- Returns: `200 { contacts: T26[] }`
|
||||
#### Create entity contact — `POST /entity/{entityId}/contact`
|
||||
- Params: `entityId: integer, body: { contactType: string, contact: string }`
|
||||
- Returns: `201 { contact: { id: integer, entityId: integer, contactType: string, contact: string } }`
|
||||
- Params: `entityId: int, body: { contactType: str, contact: str }`
|
||||
- Returns: `201 { contact: T26 }`
|
||||
#### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}`
|
||||
- Params: `entityId: integer, id: integer`
|
||||
- Params: `entityId: int, id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update entity contact — `PATCH /entity/{entityId}/contact/{id}`
|
||||
- Params: `entityId: integer, id: integer, body: { contactType?: string, contact?: string }`
|
||||
- Returns: `200 { contact: { id: integer, entityId: integer, contactType: string, contact: string } }`
|
||||
- Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }`
|
||||
- Returns: `200 { contact: T26 }`
|
||||
#### Delete entity — `DELETE /entity/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get entity — `GET /entity/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { entity: { id: integer, customergroupId: integer, firstName: string, name: string, number: string, createdAt: string, updatedAt: string } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T14`
|
||||
#### Update entity — `PATCH /entity/{id}`
|
||||
- Params: `id: integer, body: { name?: string, firstName?: string, number?: string }`
|
||||
- Returns: `200 { entity: { id: integer, customergroupId: integer, firstName: string, name: string, number: string, createdAt: string, updatedAt: string } }`
|
||||
- Params: `id: int, body: { name?: str, firstName?: str, number?: str }`
|
||||
- Returns: `200 T14`
|
||||
#### List label templates — `GET /labeltemplate`
|
||||
_none_
|
||||
- Returns: `200 { labeltemplates: { id: integer, name: string, width: number, height: number, dpi: integer, type: string, content: object, thumb: string }[] }`
|
||||
- Returns: `200 { labeltemplates: T22[] }`
|
||||
#### Create label template — `POST /labeltemplate`
|
||||
- Params: `body: { name: string, width: number, height: number, dpi: integer, type: string, content: object }`
|
||||
- Returns: `201 { labeltemplate: { id: integer, name: string, width: number, height: number, dpi: integer, type: string, content: object, thumb: string } }`
|
||||
- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: obj }`
|
||||
- Returns: `201 T16`
|
||||
#### Delete label template — `DELETE /labeltemplate/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get label template by ID — `GET /labeltemplate/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { labeltemplate: { id: integer, name: string, width: number, height: number, dpi: integer, type: string, content: object, thumb: string } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T16`
|
||||
#### Update label template (partial) — `PATCH /labeltemplate/{id}`
|
||||
- Params: `id: integer, body: { name?: string, width?: number, height?: number, dpi?: integer, type?: string, content?: object }`
|
||||
- Returns: `200 { labeltemplate: { id: integer, name: string, width: number, height: number, dpi: integer, type: string, content: object, thumb: string } }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: obj }`
|
||||
- Returns: `200 T16`
|
||||
#### Update label template — `PUT /labeltemplate/{id}`
|
||||
- Params: `id: integer, body: { name?: string, width?: number, height?: number, dpi?: integer, type?: string, content?: object }`
|
||||
- Returns: `200 { labeltemplate: { id: integer, name: string, width: number, height: number, dpi: integer, type: string, content: object, thumb: string } }`
|
||||
- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: obj }`
|
||||
- Returns: `200 T16`
|
||||
#### Query ledger by manifest article ID or SKU — `GET /ledger`
|
||||
- Params: `query: manifestarticle_id?: integer, sku?: string, transaction_type?: string`
|
||||
- Returns: `200 { ledger: { id: integer, manifestarticle_id: integer, transaction_type: string, amount: number, transaction_text: string, hash_version: integer, prev_hash: string, sku: string, created_at: string }[] }`
|
||||
- Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str`
|
||||
- Returns: `200 T10`
|
||||
#### Add ledger entry — `POST /ledger`
|
||||
- Params: `body: { manifestarticle_id: integer, transaction_type: string, amount: number, transaction_text: string }`
|
||||
- Returns: `201 { ledger: { id: integer, manifestarticle_id: integer, transaction_type: string, amount: number, transaction_text: string, hash_version: integer, prev_hash: string, sku: string, created_at: string } }`
|
||||
- Params: `body: { manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str }`
|
||||
- Returns: `201 { ledger: T11 }`
|
||||
#### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}`
|
||||
- Params: `manifestarticleId: integer, query: transaction_type?: string`
|
||||
- Returns: `200 { ledger: { id: integer, manifestarticle_id: integer, transaction_type: string, amount: number, transaction_text: string, hash_version: integer, prev_hash: string, sku: string, created_at: string }[] }`
|
||||
- Params: `manifestarticleId: int, query: transaction_type?: str`
|
||||
- Returns: `200 T10`
|
||||
#### Query ledger by article SKU — `GET /ledger/sku/{sku}`
|
||||
- Params: `sku: string, query: transaction_type?: string`
|
||||
- Returns: `200 { ledger: { id: integer, manifestarticle_id: integer, transaction_type: string, amount: number, transaction_text: string, hash_version: integer, prev_hash: string, sku: string, created_at: string }[] }`
|
||||
- Params: `sku: str, query: transaction_type?: str`
|
||||
- Returns: `200 T10`
|
||||
#### List number sequences — `GET /number`
|
||||
_none_
|
||||
- Returns: `200 { numbers: { id: integer, type: string, prefix: string, padding: integer, next: integer }[] }`
|
||||
- Returns: `200 { numbers: { id: int, type: str, prefix: str, padding: int, next: int }[] }`
|
||||
#### Update number sequence — `PATCH /number/{id}`
|
||||
- Params: `id: integer, body: { prefix?: string, padding?: integer, next?: integer }`
|
||||
- Returns: `200 { number: { id: integer, type: string, prefix: string, padding: integer, next: integer } }`
|
||||
- Params: `id: int, body: { prefix?: str, padding?: int, next?: int }`
|
||||
- Returns: `200 { number: { id: int, type: str, prefix: str, padding: int, next: int } }`
|
||||
#### List orders — `GET /order`
|
||||
_none_
|
||||
- Returns: `200 { orders: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string }[] }`
|
||||
- Returns: `200 { orders: { id: int, number: str, type: str, entityId: int, date: str, createdAt: str }[] }`
|
||||
#### Create order — `POST /order`
|
||||
- Params: `body: { number: string, date: string, lines: { amount: number, net: number, taxrate: number, sku?: string, name?: string, pu?: number, rebate?: number, comment?: string }[], entityId?: integer }`
|
||||
- Returns: `201 { order: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[] } }`
|
||||
- Params: `body: { number: str, date: str, lines: T21[], entityId?: int }`
|
||||
- Returns: `201 T5`
|
||||
#### Delete order — `DELETE /order/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get order — `GET /order/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { order: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[] } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T5`
|
||||
#### Update order — `PATCH /order/{id}`
|
||||
- Params: `id: integer, body: { number?: string, date?: string, entityId?: integer, lines?: { amount: number, net: number, taxrate: number, sku?: string, name?: string, pu?: number, rebate?: number, comment?: string }[] }`
|
||||
- Returns: `200 { order: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[] } }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int, lines?: T21[] }`
|
||||
- Returns: `200 T5`
|
||||
#### List printers — `GET /printer`
|
||||
_none_
|
||||
- Returns: `200 { printers: { id: integer, company_id: integer, address: string, type: string, model: string, serial: string, sort: integer, desc: string }[] }`
|
||||
- Returns: `200 { printers: T20[] }`
|
||||
#### Create printer — `POST /printer`
|
||||
- Params: `body: { address: string, type: string, model?: string, serial?: string, sort?: integer, desc?: string }`
|
||||
- Returns: `201 { printer: { id: integer, company_id: integer, address: string, type: string, model: string, serial: string, sort: integer, desc: string } }`
|
||||
- Params: `body: { address: str, type: str, model?: str, serial?: str, sort?: int, desc?: str }`
|
||||
- Returns: `201 T15`
|
||||
#### Reorder printers — `PUT /printer/order`
|
||||
- Params: `body: { printerIds: integer[] }`
|
||||
- Returns: `200 { printerIds: integer[] }`
|
||||
- Params: `body: { printerIds: int[] }`
|
||||
- Returns: `200 { printerIds: int[] }`
|
||||
#### Delete printer — `DELETE /printer/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get printer by ID — `GET /printer/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { printer: { id: integer, company_id: integer, address: string, type: string, model: string, serial: string, sort: integer, desc: string } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T15`
|
||||
#### Update printer (partial) — `PATCH /printer/{id}`
|
||||
- Params: `id: integer, body: { address?: string, type?: string, model?: string, serial?: string, sort?: integer, desc?: string }`
|
||||
- Returns: `200 { printer: { id: integer, company_id: integer, address: string, type: string, model: string, serial: string, sort: integer, desc: string } }`
|
||||
- Params: `id: int, body: { address?: str, type?: str, model?: str, serial?: str, sort?: int, desc?: str }`
|
||||
- Returns: `200 T15`
|
||||
#### Update printer — `PUT /printer/{id}`
|
||||
- Params: `id: integer, body: { address?: string, type?: string, model?: string, serial?: string, sort?: integer, desc?: string }`
|
||||
- Returns: `200 { printer: { id: integer, company_id: integer, address: string, type: string, model: string, serial: string, sort: integer, desc: string } }`
|
||||
- Params: `id: int, body: { address?: str, type?: str, model?: str, serial?: str, sort?: int, desc?: str }`
|
||||
- Returns: `200 T15`
|
||||
#### List property names — `GET /propertyname`
|
||||
_none_
|
||||
- Returns: `200 { propertynames: { id: integer, name: string, sort: integer, exclusive: boolean }[] }`
|
||||
- Returns: `200 { propertynames: T30[] }`
|
||||
#### Create property name — `POST /propertyname`
|
||||
- Params: `body: { name: string, sort?: integer, exclusive?: boolean }`
|
||||
- Returns: `201 { propertyname: { id: integer, name: string, sort: integer, exclusive: boolean } }`
|
||||
- Params: `body: { name: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `201 { propertyname: T30 }`
|
||||
#### Reorder property names — `PUT /propertyname/order`
|
||||
- Params: `body: { propertynameIds: integer[] }`
|
||||
- Params: `body: { propertynameIds: int[] }`
|
||||
- Returns: `200`
|
||||
#### Delete property name — `DELETE /propertyname/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `200`
|
||||
#### Update property name — `PATCH /propertyname/{id}`
|
||||
- Params: `id: integer, body: { name?: string, sort?: integer, exclusive?: boolean }`
|
||||
- Returns: `200 { propertyname: { id: integer, name: string, sort: integer, exclusive: boolean } }`
|
||||
- Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
|
||||
- Returns: `200 { propertyname: T30 }`
|
||||
#### List quotes — `GET /quote`
|
||||
_none_
|
||||
- Returns: `200 { quotes: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string }[] }`
|
||||
- Returns: `200 { quotes: { id: int, number: str, type: str, entityId: int, date: str, createdAt: str }[] }`
|
||||
#### Create quote — `POST /quote`
|
||||
- Params: `body: { number: string, date: string, lines: { amount: number, net: number, taxrate: number, sku?: string, name?: string, pu?: number, rebate?: number, comment?: string }[], entityId?: integer }`
|
||||
- Returns: `201 { quote: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[] } }`
|
||||
- Params: `body: { number: str, date: str, lines: T21[], entityId?: int }`
|
||||
- Returns: `201 T6`
|
||||
#### Delete quote — `DELETE /quote/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get quote — `GET /quote/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { quote: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[] } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T6`
|
||||
#### Update quote — `PATCH /quote/{id}`
|
||||
- Params: `id: integer, body: { number?: string, date?: string, entityId?: integer, lines?: { amount: number, net: number, taxrate: number, sku?: string, name?: string, pu?: number, rebate?: number, comment?: string }[] }`
|
||||
- Returns: `200 { quote: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string, lines: { id: integer, sku: string, name: string, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string }[] } }`
|
||||
- Params: `id: int, body: { number?: str, date?: str, entityId?: int, lines?: T21[] }`
|
||||
- Returns: `200 T6`
|
||||
#### Adjust stock manually — `POST /stock/adjust`
|
||||
- Params: `body: { sku?: string, warehouseId?: integer, amount?: number, text?: string, lines?: { sku: string, amount: number, warehouseId?: integer, text?: string }[] }`
|
||||
- Returns: `201 { manifest: { id: integer, number: string, type: string, date: string, createdAt: string }, lines: object[], ledger: { id: integer, manifestarticle_id: integer, transaction_type: string, amount: number, transaction_text: string, hash_version: integer, prev_hash: string, sku: string, created_at: string }[] }`
|
||||
- Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }`
|
||||
- Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: obj[], ledger: T11[] }`
|
||||
#### List suppliers — `GET /supplier`
|
||||
_none_
|
||||
- Returns: `200 { suppliers: { id: integer, name: string, createdAt: string, updatedAt: string }[] }`
|
||||
- Returns: `200 { suppliers: T28[] }`
|
||||
#### Create supplier — `POST /supplier`
|
||||
- Params: `body: { name: string }`
|
||||
- Returns: `201 { supplier: { id: integer, name: string, createdAt: string, updatedAt: string } }`
|
||||
- Params: `body: { name: str }`
|
||||
- Returns: `201 { supplier: T28 }`
|
||||
#### Delete supplier — `DELETE /supplier/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Update supplier — `PATCH /supplier/{id}`
|
||||
- Params: `id: integer, body: { name: string }`
|
||||
- Returns: `200 { supplier: { id: integer, name: string, createdAt: string, updatedAt: string } }`
|
||||
- Params: `id: int, body: { name: str }`
|
||||
- Returns: `200 { supplier: T28 }`
|
||||
#### List supplier articles by SKUs — `GET /supplier/{id}/articles`
|
||||
- Params: `id: integer, query: skus?: string`
|
||||
- Returns: `200 { articles: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number }, article: { id: integer, sku: string, name: string, slug: string, photos: { sort: integer, fullHash: string, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[] } }[] }`
|
||||
- Params: `id: int, query: skus?: string`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, supplierName: str, sku: str, pu: num, stock: num, sort: int, priceId: int, price: T32, article: { id: int, sku: str, name: str, slug: str, photos: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[] } }[] }`
|
||||
#### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles`
|
||||
- Params: `id: integer, body?: { skus?: string[] }`
|
||||
- Returns: `200 { articles: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number }, article: { id: integer, sku: string, name: string, slug: string, photos: { sort: integer, fullHash: string, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[] } }[] }`
|
||||
- Params: `id: int, body?: { skus?: str[] }`
|
||||
- Returns: `200 { articles: { id: int, articleId: int, entityId: int, supplierName: str, sku: str, pu: num, stock: num, sort: int, priceId: int, price: T32, article: { id: int, sku: str, name: str, slug: str, photos: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[] } }[] }`
|
||||
#### Delete unit — `DELETE /unit`
|
||||
- Params: `query: si: string`
|
||||
- Params: `query: si: str`
|
||||
- Returns: `204 void`
|
||||
#### List units — `GET /unit`
|
||||
_none_
|
||||
- Returns: `200 { units: { si: string, basesi: string, basesifactor: number, symbol: string, name: string }[] }`
|
||||
- Returns: `200 { units: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }[] }`
|
||||
#### Upsert unit — `PUT /unit`
|
||||
- Params: `body: { si: string, basesi: string, basesifactor: number, symbol: string, name: string }`
|
||||
- Returns: `200 { unit: { si: string, basesi: string, basesifactor: number, symbol: string, name: string } }`
|
||||
- Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
|
||||
- Returns: `200 { unit: { si: str, basesi: str, basesifactor: num, symbol: str, name: str } }`
|
||||
#### Get a virtual filesystem file — `GET /vfs/{*path}`
|
||||
- Params: `path: string, query: download?: boolean`
|
||||
- Returns: `200 string`
|
||||
- Params: `path: str, query: download?: bool`
|
||||
- Returns: `200 str`
|
||||
#### List warehouses — `GET /warehouse`
|
||||
_none_
|
||||
- Returns: `200 { warehouses: { id: integer, name: string, sort: integer }[] }`
|
||||
- Returns: `200 { warehouses: T33[] }`
|
||||
#### Create warehouse — `POST /warehouse`
|
||||
- Params: `body: { name: string, sort?: integer }`
|
||||
- Returns: `201 { warehouse: { id: integer, name: string, sort: integer } }`
|
||||
- Params: `body: { name: str, sort?: int }`
|
||||
- Returns: `201 T31`
|
||||
#### Reorder warehouses — `PUT /warehouse/order`
|
||||
- Params: `body: { warehouseIds: integer[] }`
|
||||
- Returns: `200 { warehouseIds: integer[] }`
|
||||
- Params: `body: { warehouseIds: int[] }`
|
||||
- Returns: `200 { warehouseIds: int[] }`
|
||||
#### Delete warehouse — `DELETE /warehouse/{id}`
|
||||
- Params: `id: integer`
|
||||
- Params: `id: int`
|
||||
- Returns: `204 void`
|
||||
#### Get warehouse by ID — `GET /warehouse/{id}`
|
||||
- Params: `id: integer`
|
||||
- Returns: `200 { warehouse: { id: integer, name: string, sort: integer } }`
|
||||
- Params: `id: int`
|
||||
- Returns: `200 T31`
|
||||
#### Update warehouse (partial) — `PATCH /warehouse/{id}`
|
||||
- Params: `id: integer, body: { name?: string, sort?: integer }`
|
||||
- Returns: `200 { warehouse: { id: integer, name: string, sort: integer } }`
|
||||
- Params: `id: int, body: { name?: str, sort?: int }`
|
||||
- Returns: `200 T31`
|
||||
#### Update warehouse — `PUT /warehouse/{id}`
|
||||
- Params: `id: integer, body: { name?: string, sort?: integer }`
|
||||
- Returns: `200 { warehouse: { id: integer, name: string, sort: integer } }`
|
||||
- Params: `id: int, body: { name?: str, sort?: int }`
|
||||
- Returns: `200 T31`
|
||||
### Binary & streaming routes (reachable only via `fetch()` in javascript_execute)
|
||||
|
||||
These routes are NOT in the table above because their responses are binary or long-lived streams, which the `dashback_request` tool cannot return usefully. They ARE reachable from inside `javascript_execute` with `fetch("/route")`, where you can decode the bytes, write them to the VFS and embed them in your reply:
|
||||
|
||||
Reference in New Issue
Block a user