475 lines
42 KiB
Markdown
475 lines
42 KiB
Markdown
# Dash API Routes Overview
|
|
|
|
Overview of all 145 API endpoints across all modules.
|
|
|
|
### Parameter 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.
|
|
|
|
### 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 } }`
|
|
#### Delete article by SKU — `DELETE /article/{sku}`
|
|
- Params: `sku: string, query: cascade?: boolean`
|
|
- 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 } }[] } }`
|
|
#### 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 } }[] } }`
|
|
#### 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 }[] }`
|
|
#### 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[] }`
|
|
#### 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 }[] }`
|
|
#### 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 }[] }`
|
|
#### 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 } }[] } }`
|
|
#### 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 } }[] } }`
|
|
#### 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 }[] }`
|
|
#### 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 } }`
|
|
#### 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[] }`
|
|
#### 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 }`
|
|
#### 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 } }[] } }`
|
|
#### 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 }`
|
|
#### Delete article image — `DELETE /article/{sku}/image/{fullHash}`
|
|
- Params: `sku: string, fullHash: string`
|
|
- Returns: `204 void`
|
|
#### Reorder article images — `PUT /article/{sku}/images/order`
|
|
- Params: `sku: string, body: { fullHashes: string[] }`
|
|
- Returns: `200 { fullHashes: string[] }`
|
|
#### 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 }[] }`
|
|
#### 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[] }`
|
|
#### 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 } }`
|
|
#### 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 } }[] } }`
|
|
#### Print article label — `POST /article/{sku}/print`
|
|
- Params: `sku: string, body: { templateId: integer, printerId: integer, quantity: integer }`
|
|
- 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 }[] }`
|
|
#### 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 }[] }`
|
|
#### Delete article property — `DELETE /article/{sku}/property/{propertyId}`
|
|
- Params: `sku: string, propertyId: integer`
|
|
- 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 } }[] }`
|
|
#### 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 } } }`
|
|
#### Reorder article suppliers — `PUT /article/{sku}/supplier/order`
|
|
- Params: `sku: string, body: { ids: integer[] }`
|
|
- Returns: `200 { ids: integer[] }`
|
|
#### Remove supplier assignment from article — `DELETE /article/{sku}/supplier/{id}`
|
|
- Params: `sku: string, id: integer`
|
|
- 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 } } }`
|
|
#### 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 } }[] } }`
|
|
#### 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 }`
|
|
#### 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 }[] }[] }`
|
|
#### 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 }[] } }`
|
|
#### Reorder attribute names — `PUT /attributename/order`
|
|
- Params: `body: { attributenameIds: integer[] }`
|
|
- 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 }[] }`
|
|
#### 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 } }`
|
|
#### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order`
|
|
- Params: `attributeId: integer, body: { attributevalueIds: integer[] }`
|
|
- Returns: `200`
|
|
#### Delete attribute name — `DELETE /attributename/{id}`
|
|
- Params: `id: integer`
|
|
- 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 }[] } }`
|
|
#### Delete attribute value — `DELETE /attributevalue/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### 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 } }`
|
|
#### Logout — `POST /auth/logout`
|
|
_none_
|
|
- Returns: `200 { message: string }`
|
|
#### 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 }[] }[] }`
|
|
#### 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 }[] } }`
|
|
#### Delete brand — `DELETE /brand/{id}`
|
|
- Params: `id: integer`
|
|
- Returns: `204 void`
|
|
#### Create category — `POST /category`
|
|
- Params: `body: { parentId: integer, name: string }`
|
|
- Returns: `201 { category: { id: integer, parentId: integer, sort: integer, name: string } }`
|
|
#### Reorder sibling categories — `PUT /category/order`
|
|
- Params: `body: { parentId: integer, categoryIds: integer[] }`
|
|
- Returns: `200 { categoryIds: integer[] }`
|
|
#### Category tree — `GET /category/tree`
|
|
_none_
|
|
- Returns: `200 { languageId: integer, tree: object[], articles: object[] }`
|
|
#### Delete category — `DELETE /category/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### 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 }[] }`
|
|
#### 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 }[] }`
|
|
#### 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 }[] }`
|
|
#### Delete category image — `DELETE /category/{id}/image`
|
|
- Params: `id: integer`
|
|
- Returns: `200 { category: { id: integer, thumbW: integer, thumbH: integer, thumbHash: string } }`
|
|
#### 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 }[] }`
|
|
#### 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 }[] }`
|
|
#### Delete category property — `DELETE /category/{id}/property/{propertyId}`
|
|
- Params: `id: integer, propertyId: integer`
|
|
- Returns: `200`
|
|
#### List companies — `GET /company`
|
|
_none_
|
|
- Returns: `200 { companies: { id: integer, iso639: string, name: string, taxrate: number, reducedtaxrate: number }[] }`
|
|
#### Get company history — `GET /company/history`
|
|
- Params: `query: limit?: integer`
|
|
- Returns: `200 { history: { id: integer, companyuserId: integer, date: string, text: string }[], truncated: boolean }`
|
|
#### Add company history entry — `POST /company/history`
|
|
- Params: `body: { text: string }`
|
|
- Returns: `201 { history: { id: integer, companyuserId: integer, date: string, text: string } }`
|
|
#### List company settings — `GET /company/setting`
|
|
_none_
|
|
- Returns: `200 { settings: { key: string, value: string }[] }`
|
|
#### Get company setting by key — `GET /company/setting/{key}`
|
|
- Params: `key: string`
|
|
- Returns: `200 { setting: { key: string, value: string } }`
|
|
#### Upsert company setting — `PUT /company/setting/{key}`
|
|
- Params: `key: string, body: { value: string, frontend?: boolean }`
|
|
- Returns: `200 { setting: { key: string, value: string } }`
|
|
#### 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 } }`
|
|
#### List customer groups — `GET /customergroup`
|
|
_none_
|
|
- Returns: `200 { customergroups: { id: integer, name: string, sort: integer, editable: boolean }[] }`
|
|
#### Create customer group — `POST /customergroup`
|
|
- Params: `body: { name: string }`
|
|
- Returns: `201 { customergroup: { id: integer, name: string, sort: integer } }`
|
|
#### Reorder customer groups — `PUT /customergroup/order`
|
|
- Params: `body: { customergroupIds: integer[] }`
|
|
- Returns: `200 { customergroupIds: integer[] }`
|
|
#### Delete customer group — `DELETE /customergroup/{id}`
|
|
- Params: `id: integer`
|
|
- Returns: `204 void`
|
|
#### Update customer group — `PATCH /customergroup/{id}`
|
|
- Params: `id: integer, body: { name: string }`
|
|
- Returns: `200 { customergroup: { id: integer, name: string, sort: integer } }`
|
|
#### 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 } }[] }`
|
|
#### 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 }[] } }`
|
|
#### Delete delivery — `DELETE /delivery/{id}`
|
|
- Params: `id: integer`
|
|
- 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 }[] } }`
|
|
#### 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 }[] } }`
|
|
#### Get delivery attachment file content — `GET /delivery/{id}/file/{fileId}`
|
|
- Params: `id: integer, fileId: integer, query: download?: boolean`
|
|
- Returns: `200 string`
|
|
#### 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 }[] }`
|
|
#### 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 } }`
|
|
#### Peek next customer number — `GET /entity/next-number`
|
|
_none_
|
|
- Returns: `200 { number: string }`
|
|
#### 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 }[] }`
|
|
#### 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 } }`
|
|
#### Delete entity address — `DELETE /entity/{entityId}/address/{id}`
|
|
- Params: `entityId: integer, id: integer`
|
|
- 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 } }`
|
|
#### List entity contacts — `GET /entity/{entityId}/contact`
|
|
- Params: `entityId: integer`
|
|
- Returns: `200 { contacts: { id: integer, entityId: integer, contactType: string, contact: string }[] }`
|
|
#### 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 } }`
|
|
#### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}`
|
|
- Params: `entityId: integer, id: integer`
|
|
- 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 } }`
|
|
#### Delete entity — `DELETE /entity/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### 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 } }`
|
|
#### 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 }[] }`
|
|
#### 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 } }`
|
|
#### Delete label template — `DELETE /labeltemplate/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### 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 } }`
|
|
#### 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 } }`
|
|
#### 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 }[] }`
|
|
#### 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 } }`
|
|
#### 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 }[] }`
|
|
#### 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 }[] }`
|
|
#### List number sequences — `GET /number`
|
|
_none_
|
|
- Returns: `200 { numbers: { id: integer, type: string, prefix: string, padding: integer, next: integer }[] }`
|
|
#### 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 } }`
|
|
#### List orders — `GET /order`
|
|
_none_
|
|
- Returns: `200 { orders: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string }[] }`
|
|
#### 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 }[] } }`
|
|
#### Delete order — `DELETE /order/{id}`
|
|
- Params: `id: integer`
|
|
- 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 }[] } }`
|
|
#### 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 }[] } }`
|
|
#### 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 }[] }`
|
|
#### 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 } }`
|
|
#### Reorder printers — `PUT /printer/order`
|
|
- Params: `body: { printerIds: integer[] }`
|
|
- Returns: `200 { printerIds: integer[] }`
|
|
#### Delete printer — `DELETE /printer/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### 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 } }`
|
|
#### 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 } }`
|
|
#### List property names — `GET /propertyname`
|
|
_none_
|
|
- Returns: `200 { propertynames: { id: integer, name: string, sort: integer, exclusive: boolean }[] }`
|
|
#### Create property name — `POST /propertyname`
|
|
- Params: `body: { name: string, sort?: integer, exclusive?: boolean }`
|
|
- Returns: `201 { propertyname: { id: integer, name: string, sort: integer, exclusive: boolean } }`
|
|
#### Reorder property names — `PUT /propertyname/order`
|
|
- Params: `body: { propertynameIds: integer[] }`
|
|
- Returns: `200`
|
|
#### Delete property name — `DELETE /propertyname/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### List quotes — `GET /quote`
|
|
_none_
|
|
- Returns: `200 { quotes: { id: integer, number: string, type: string, entityId: integer, date: string, createdAt: string }[] }`
|
|
#### 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 }[] } }`
|
|
#### Delete quote — `DELETE /quote/{id}`
|
|
- Params: `id: integer`
|
|
- 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 }[] } }`
|
|
#### 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 }[] } }`
|
|
#### 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 }[] }`
|
|
#### List suppliers — `GET /supplier`
|
|
_none_
|
|
- Returns: `200 { suppliers: { id: integer, name: string, createdAt: string, updatedAt: string }[] }`
|
|
#### Create supplier — `POST /supplier`
|
|
- Params: `body: { name: string }`
|
|
- Returns: `201 { supplier: { id: integer, name: string, createdAt: string, updatedAt: string } }`
|
|
#### Delete supplier — `DELETE /supplier/{id}`
|
|
- Params: `id: integer`
|
|
- 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 } }`
|
|
#### 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[] } }[] }`
|
|
#### 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[] } }[] }`
|
|
#### Delete unit — `DELETE /unit`
|
|
- Params: `query: si: string`
|
|
- Returns: `204 void`
|
|
#### List units — `GET /unit`
|
|
_none_
|
|
- Returns: `200 { units: { si: string, basesi: string, basesifactor: number, symbol: string, name: string }[] }`
|
|
#### 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 } }`
|
|
#### Get a virtual filesystem file — `GET /vfs/{*path}`
|
|
- Params: `path: string, query: download?: boolean`
|
|
- Returns: `200 string`
|
|
#### List warehouses — `GET /warehouse`
|
|
_none_
|
|
- Returns: `200 { warehouses: { id: integer, name: string, sort: integer }[] }`
|
|
#### Create warehouse — `POST /warehouse`
|
|
- Params: `body: { name: string, sort?: integer }`
|
|
- Returns: `201 { warehouse: { id: integer, name: string, sort: integer } }`
|
|
#### Reorder warehouses — `PUT /warehouse/order`
|
|
- Params: `body: { warehouseIds: integer[] }`
|
|
- Returns: `200 { warehouseIds: integer[] }`
|
|
#### Delete warehouse — `DELETE /warehouse/{id}`
|
|
- Params: `id: integer`
|
|
- Returns: `204 void`
|
|
#### Get warehouse by ID — `GET /warehouse/{id}`
|
|
- Params: `id: integer`
|
|
- Returns: `200 { warehouse: { id: integer, name: string, sort: integer } }`
|
|
#### Update warehouse (partial) — `PATCH /warehouse/{id}`
|
|
- Params: `id: integer, body: { name?: string, sort?: integer }`
|
|
- Returns: `200 { warehouse: { id: integer, name: string, sort: integer } }`
|
|
#### Update warehouse — `PUT /warehouse/{id}`
|
|
- Params: `id: integer, body: { name?: string, sort?: integer }`
|
|
- Returns: `200 { warehouse: { id: integer, name: string, sort: integer } }`
|
|
### 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:
|
|
|
|
| Method | Route | Returns | Notes |
|
|
|:---|:---|:---|:---|
|
|
| `GET` | `/image/{fullHash}` | `image/avif` | Full-size article/brand/category image by SHA-256 hash. Use for inspecting or re-encoding an existing image.
|
|
| `GET` | `/thumb/{fullHash}` | `image/avif` | Thumb AVIF by SHA-256 hash — cheaper than the full image. Takes the same `fullHash` as `/image/{fullHash}`.
|
|
| `POST` | `/serper/image` | `image/avif` | Crawl an image from a URL, auto-crop transparent/white borders. Body: `{ url }`.
|
|
|
|
Save the bytes to the VFS, then embed them in your reply as ``:
|
|
|
|
```js
|
|
module.exports = (async () => {
|
|
const hash = "…64-char sha-256…";
|
|
const res = await fetch(`/thumb/${hash}`); // authenticated automatically
|
|
const buf = Buffer.from(await res.arrayBuffer());
|
|
fs.writeFileSync("artifacts/thumb.avif", buf);
|
|
return { bytes: buf.length };
|
|
})();
|
|
```
|
|
|
|
`fullHash` appears on articles, brands and categories. `thumbHash` is a base64 blur-up placeholder, not a content hash, and is not accepted here.
|