# Dash API Routes Overview Overview of all 227 API endpoints across all modules. ### Notation Types: `str` string, `int` integer, `num` number, `bool` boolean; `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` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T14[], externalNumber?: str|null, createdAt?: str, shipping?: T17|null, shippings?: T17[], payment?: T25|null, payments?: T25[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T7[] }` - `T2` = `{ id: int, number: str, type: str, date: str, lines: T14[], shippings: T17[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }` - `T3` = `{ id: int, number: str, type: str, date: str, lines: T14[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` - `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T18[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T30 }` - `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }` - `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T19[] }, thumb?: str|null }` - `T7` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` - `T8` = `{ id: int, name: str, companyId?: int, token?: str|null, pairingpin?: str|null, pairedAt?: str|null, agentversion?: str|null, lastseenAt?: str|null, updatedAt?: str, sort?: int, enabled?: bool }` - `T9` = `{ id: int, printeragentId: int, type: str, enabled: bool, sort: int, model?: str|null, serial?: str|null, open?: bool, pause?: bool, error?: bool, online?: bool, labelLength?: int|null }` - `T10` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` - `T11` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` - `T12` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` - `T13` = `{ id: int, name: str, sort: int, exclusive: bool, values: T23[], articleCount?: int }` - `T14` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` - `T15` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` - `T16` = `{ id: int, agentprinterId: int, type: str, state: str, data: str, createdAt: str, printeragentId?: int|null, completedAt?: str|null }` - `T17` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` - `T18` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` - `T19` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` - `T20` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` - `T21` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` - `T22` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` - `T23` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` - `T24` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` - `T25` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` - `T26` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` - `T27` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` - `T28` = `{ id: int, entityId: int, contactType: str, contact: str }` - `T29` = `{ id: int, name: str, createdAt: str, updatedAt: str }` - `T30` = `{ totalPositions: int, completelyOnLedgerPositions: int }` - `T31` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes ### Section: /agent #### Printer agent SSE stream — `GET /agent/events` - Params: `query: token?: str, agentversion?: str` - Returns: `200 SSE` #### Pair printer agent via query parameters — `GET /agent/pair` - Params: `query: authCode?: str, pairingpin?: str, serial?: str, model?: str, version?: str` - Returns: `200` #### Pair printer agent — `POST /agent/pair` - Params: `body: { pairingpin: str, clientserial?: str, clientmodel?: str, agentversion?: str }` - Returns: `200 { id: int, name: str, companyId: int, token: str, pairedAt: str, clientserial: str|null, clientmodel: str|null, agentversion: str|null, sort: int }` #### Post agent state — `POST /agent/state` - Params: `body: { state?: any }` - Returns: `200 { success: bool, agent: T8 }` ### Section: /agentprinter #### List agent printers — `GET /agentprinter` - Params: `query: printeragentId?: int` - Returns: `200 { agentprinters: T9[] }` #### Reorder agent printers — `PUT /agentprinter/order` - Params: `body: { agentprinterIds: int[], printeragentId?: int }` - Returns: `200 { agentprinterIds: int[] }` #### Delete agent printer — `DELETE /agentprinter/{id}` - Params: `id: int` - Returns: `204 void` #### Get agent printer — `GET /agentprinter/{id}` - Params: `id: int` - Returns: `200 { agentprinter: T9 }` #### Update agent printer — `PATCH /agentprinter/{id}` - Params: `id: int, body: { enabled?: bool, sort?: int }` - Returns: `200 { agentprinter: T9 }` ### Section: /article #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` - Returns: `201 { sku: str }` #### Query company-wide article history — `GET /article/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { history: { id: int, date: str, sku: str, historytext: str, name?: str|null }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Delete article by SKU — `DELETE /article/{sku}` - Params: `sku: str, query: cascade?: bool` - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` - Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T22, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` #### Update article by SKU — `PATCH /article/{sku}` - Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }` - Returns: `204 void` #### Get Stückliste (bundle items) for an article — `GET /article/{sku}/articlelist` - 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: str, body: { items: { articleId?: int, sku?: str, count?: int, sort?: int }[] }` - Returns: `200 { items: { id: int, articleId: int, sku: str, name: str, count: int, sort: int }[] }` #### List article attribute values — `GET /article/{sku}/attributevalue` - Params: `sku: str` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, articleId?: int, exclusive?: bool }[] }` #### Bulk set article attribute values — `PUT /article/{sku}/attributevalue` - Params: `sku: str, body: int[]` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, articleId?: int, exclusive?: bool }[] }` #### Set or clear article brand by SKU (null to clear) — `PUT /article/{sku}/brand` - Params: `sku: str, body: { brandId: int|null }` - Returns: `204 void` #### Replace article categories by SKU — `PUT /article/{sku}/categories` - Params: `sku: str, body: { categoryIds: int[] }` - Returns: `204 void` #### List child articles of a parent article — `GET /article/{sku}/children` - 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: str, body: { attributeValueId?: int, value?: str, name?: str }` - Returns: `201 { sku: str }` #### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children` - Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }` - Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}` - 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: str, body: { eans: str[] }` - Returns: `204 void` #### Get article history by SKU — `GET /article/{sku}/history` - Params: `sku: str, query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { history: { id: int, date: str, text: str }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Delete article image — `DELETE /article/{sku}/image/{fullHash}` - Params: `sku: str, fullHash: str` - Returns: `204 void` #### Reorder article images — `PUT /article/{sku}/images/order` - Params: `sku: str, body: { fullHashes: str[] }` - Returns: `200 { fullHashes: str[] }` #### Get options list for an article — `GET /article/{sku}/optionslist` - 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: str, body: { options: { articleId?: int, sku?: str, count?: int, sort?: int, mandated?: bool }[] }` - Returns: `200 { options: { id: int, articleId: int, sku: str, name: str, count: int, sort: int, mandated: bool }[] }` #### Toggle parent mode for an article — `POST /article/{sku}/parent` - Params: `sku: str, body: { isParent: bool, attributeNameId?: int }` - Returns: `204 void` #### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices` - Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }` - Returns: `204 void` #### Print article label — `POST /article/{sku}/print` - Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }` - Returns: `200 { success: bool }` #### List article properties — `GET /article/{sku}/property` - Params: `sku: str` - Returns: `200 { properties: { id: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int, articleId?: int }[] }` #### Bulk set article properties — `PUT /article/{sku}/property` - Params: `sku: str, body: { properties: { propertyId: int, value: str, sort?: int }[] }` - Returns: `200 { properties: { id: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int, articleId?: int }[] }` #### Delete article property — `DELETE /article/{sku}/property/{propertyId}` - Params: `sku: str, propertyId: int` - Returns: `200 { ok: bool }` #### List article suppliers — `GET /article/{sku}/supplier` - Params: `sku: str` - Returns: `200 { suppliers: T5[] }` #### Assign supplier to article — `POST /article/{sku}/supplier` - Params: `sku: str, body: { entityId: int, sku?: str|null, pu?: num, stock?: num|null, sort?: int|null, netPrice?: num|null, taxId?: int|null, taxRate?: num|null }` - Returns: `201 { supplier: T5 }` #### Reorder article suppliers — `PUT /article/{sku}/supplier/order` - Params: `sku: str, body: { ids: int[] }` - Returns: `200 { ids: int[] }` #### Remove supplier assignment from article — `DELETE /article/{sku}/supplier/{id}` - Params: `sku: str, id: int` - Returns: `204 void` #### Update article supplier assignment — `PATCH /article/{sku}/supplier/{id}` - Params: `sku: str, id: int, body: { sku?: str|null, pu?: num, stock?: num|null, sort?: int, netPrice?: num|null, taxId?: int|null, taxRate?: num|null }` - Returns: `200 { supplier: T5 }` #### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock` - Params: `sku: str, body: { track_stock: bool }` - Returns: `204 void` #### Set article weight by SKU — `PUT /article/{sku}/weight` - Params: `sku: str, body: { weight: num }` - Returns: `204 void` ### Section: /attributename #### List attribute names — `GET /attributename` _none_ - Returns: `200 { attributenames: T13[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` - Returns: `201 { attributename: T13 }` #### Reorder attribute names — `PUT /attributename/order` - Params: `body: { attributenameIds: int[] }` - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` - Returns: `200 { values: T23[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` - Returns: `201 { attributevalue: T23 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` #### Delete attribute name — `DELETE /attributename/{id}` - Params: `id: int` - Returns: `200 { ok: bool }` #### Update attribute name — `PATCH /attributename/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` - Returns: `200 { attributename: T13 }` ### Section: /attributevalue #### Delete attribute value — `DELETE /attributevalue/{id}` - Params: `id: int` - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` - Returns: `200 { attributevalue: T23 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` - Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` ### Section: /brand #### List brands — `GET /brand` - Params: `query: offset?: int, limit?: int, includeSmallThumbs?: bool` - Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }` #### Create brand — `POST /brand` - Params: `body: { name: str, gsprpinfo?: str }` - Returns: `201 { brand: { id: int, name: str, pics: T27[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` #### Rename brand — `PATCH /brand/{id}` - Params: `id: int, body: { name?: str, gsprpinfo?: str }` - Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }` #### Delete brand image — `DELETE /brand/{id}/image` - Params: `id: int` - Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ - Returns: `200 { carriers: T26[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` - Returns: `201 { carrier: T26 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` #### Delete carrier — `DELETE /carrier/{id}` - Params: `id: int` - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` - Returns: `200 { carrier: T26 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` - Returns: `200 { carrier: T26 }` ### Section: /category #### Create category — `POST /category` - Params: `body: { parentId: int, name: str }` - Returns: `201 { category: { id: int, parentId: int|null, sort: int, name: str } }` #### Reorder sibling categories — `PUT /category/order` - Params: `body: { parentId: int, categoryIds: int[] }` - Returns: `200 { categoryIds: int[] }` #### Category tree — `GET /category/tree` _none_ - Returns: `200 { languageId: int, tree: { id: int, sort: int, posterminalIds: int[], parentId?: int|null, name?: str|null, slug?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, articleCount?: int }[], articleCount: int }` #### Delete category — `DELETE /category/{id}` - Params: `id: int, query: recursive?: bool` - Returns: `204 void` #### Update category (rename or move) — `PATCH /category/{id}` - 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: int, query: includeChildren?: bool` - Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` #### List category attribute values — `GET /category/{id}/attributevalue` - Params: `id: int` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` #### Bulk set category attribute values — `PUT /category/{id}/attributevalue` - Params: `id: int, body: int[]` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` #### Delete category image — `DELETE /category/{id}/image` - Params: `id: int` - Returns: `200 { category: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null } }` #### Generate category mosaic image from contents — `POST /category/{id}/image/generate` - Params: `id: int, body?: { size?: int }` - Returns: `200 { category: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, size: int, grid: str, articleCount: int } }` #### List category properties — `GET /category/{id}/property` - Params: `id: int` - Returns: `200 { properties: { id: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int, categoryId?: int }[] }` #### Bulk set category properties — `PUT /category/{id}/property` - Params: `id: int, body: { properties: { propertyId: int, value: str, sort?: int }[] }` - Returns: `200 { properties: { id: int, propertyId: int, name: str, exclusive: bool, value: str, sort: int, categoryId?: int }[] }` #### Delete category property — `DELETE /category/{id}/property/{propertyId}` - Params: `id: int, propertyId: int` - Returns: `200 { ok: bool }` ### Section: /company #### List companies — `GET /company` _none_ - Returns: `200 { companies: { id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }[] }` #### Get company history — `GET /company/history` - Params: `query: limit?: int` - Returns: `200 { history: { id: int, date: str, text: str, companyuserId?: int|null }[], truncated: bool }` #### Add company history entry — `POST /company/history` - Params: `body: { text: str }` - Returns: `201 { history: { id: int, date: str, text: str, companyuserId?: int|null } }` #### Import company catalog from zip archive (SSE) — `POST /company/import` - Params: `form: { file?: str }` - Returns: `200 SSE` #### List company settings — `GET /company/setting` _none_ - Returns: `200 { settings: { key: str, value: str|null }[] }` #### Get company setting by key — `GET /company/setting/{key}` - Params: `key: str` - Returns: `200 { setting: { key: str, value: str|null } }` #### Upsert company setting — `PUT /company/setting/{key}` - Params: `key: str, body: { value: str, frontend?: bool }` - Returns: `200 { setting: { key: str, value: str|null } }` #### Update company — `PUT /company/{id}` - Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` - Returns: `200 { company: { id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num } }` ### Section: /customergroup #### List customer groups — `GET /customergroup` _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` - Returns: `201 { customergroup: { id: int, name: str, sort: int } }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` #### Delete customer group — `DELETE /customergroup/{id}` - Params: `id: int` - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` - Returns: `200 { customergroup: { id: int, name: str, sort: int } }` ### Section: /delivery #### List deliveries — `GET /delivery` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int` - Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T30 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` - Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T4 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` - Returns: `204 void` #### Get delivery — `GET /delivery/{id}` - Params: `id: int` - Returns: `200 { delivery: T4 }` #### Update delivery — `PATCH /delivery/{id}` - Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 { delivery: T4 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T7, fileUrl: str }` ### Section: /entity #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` - Returns: `200 { entities: T21[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` - Returns: `201 { entity: T21 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` #### List entity addresses — `GET /entity/{entityId}/address` - Params: `entityId: int` - Returns: `200 { addresses: T10[] }` #### Create entity address — `POST /entity/{entityId}/address` - Params: `entityId: int, body: { addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` - Returns: `201 { address: T10 }` #### Delete entity address — `DELETE /entity/{entityId}/address/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity address — `PATCH /entity/{entityId}/address/{id}` - Params: `entityId: int, id: int, body: { addressType?: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` - Returns: `200 { address: T10 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` - Returns: `200 { contacts: T28[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` - Returns: `201 { contact: T28 }` #### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity contact — `PATCH /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }` - Returns: `200 { contact: T28 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` - Returns: `200 { entity: T21 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` - Returns: `200 { entity: T21 }` ### Section: /health #### Health latency history — `GET /health/latency` - Params: `query: range?: str` - Returns: `200 { raw: { timestamp: int, value: num }[], avg: { timestamp: int, value: num }[], max: { timestamp: int, value: num }[] }` ### Section: /labeltemplate #### List label templates — `GET /labeltemplate` _none_ - Returns: `200 { labeltemplates: { id: int, name: str, width: num, height: num, dpi: int, type: str, thumb?: str|null }[] }` #### Create label template — `POST /labeltemplate` - Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T19[] } }` - Returns: `201 { labeltemplate: T6 }` #### Test print label template — `POST /labeltemplate/testprint` - Params: `body: { printerId?: int, agentprinterId?: int, templateId?: int, objects?: any[], width?: int, height?: int, dpi?: int, sku?: str, quantity?: int }` - Returns: `200 { success: bool }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` - Returns: `204 void` #### Get label template by ID — `GET /labeltemplate/{id}` - Params: `id: int` - Returns: `200 { labeltemplate: T6 }` #### Update label template (partial) — `PATCH /labeltemplate/{id}` - Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T19[] } }` - Returns: `200 { labeltemplate: T6 }` #### Update label template — `PUT /labeltemplate/{id}` - Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T19[] } }` - Returns: `200 { labeltemplate: T6 }` ### Section: /ledger #### Query ledger by manifest article ID or SKU — `GET /ledger` - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str` - Returns: `200 { ledger: T12[] }` #### Query company-wide ledger history — `GET /ledger/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` - Returns: `200 { ledger: T12[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` - Returns: `200 { ledger: T12[] }` ### Section: /number #### List number sequences — `GET /number` _none_ - Returns: `200 { numbers: { id: int, type: str, prefix: str, padding: int, next: int }[] }` #### Update number sequence — `PATCH /number/{id}` - Params: `id: int, body: { prefix?: str, padding?: int, next?: int }` - Returns: `200 { number: { id: int, type: str, prefix: str, padding: int, next: int } }` ### Section: /order #### List orders — `GET /order` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` - Params: `body: { number: str, date: str, entityId: int, lines: T15[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` - Returns: `204 void` #### Get order — `GET /order/{id}` - Params: `id: int` - Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` - Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }` - Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` - Returns: `200 { payments: T25[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` - Returns: `201 { payment: T25 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T7, fileUrl: str }` #### List shipments of an order — `GET /order/{id}/shipment` - Params: `id: int` - Returns: `200 { shipments: T2[] }` #### Create shipment for an order — `POST /order/{id}/shipment` - Params: `id: int, body: { lines: { sku?: str, orderLineId?: int, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[], date?: str, warehouseId?: int, externalNumber?: str }` - Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` - Returns: `200 { shippings: T17[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` - Returns: `201 { shipping: T17 }` ### Section: /package #### Delete package — `DELETE /package/{id}` - Params: `id: int` - Returns: `204 void` ### Section: /payment #### Delete payment — `DELETE /payment/{id}` - Params: `id: int` - Returns: `204 void` ### Section: /printer #### List printers — `GET /printer` _none_ - Returns: `200 { printers: T20[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` - Returns: `201 { printer: T20 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` #### Get live printer states — `GET /printer/state` - Params: `query: serial?: str, agentId?: int` - Returns: `200 { printers: {}[] }` #### Delete printer — `DELETE /printer/{id}` - Params: `id: int` - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` - Returns: `200 { printer: T20 }` #### Update printer (partial) — `PATCH /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` - Returns: `200 { printer: T20 }` #### Update printer — `PUT /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` - Returns: `200 { printer: T20 }` #### Get live state for a printer — `GET /printer/{id}/state` - Params: `id: str` - Returns: `200 { printer: {} }` ### Section: /printeragent #### List printer agents — `GET /printeragent` _none_ - Returns: `200 { printeragents: T8[] }` #### Create printer agent — `PUT /printeragent` - Params: `body: { name: str, sort?: int, enabled?: bool }` - Returns: `200 { printeragent: T8 }` #### Delete printer agent — `DELETE /printeragent/{id}` - Params: `id: int` - Returns: `204 void` #### Update printer agent — `PATCH /printeragent/{id}` - Params: `id: int, body: { name?: str, sort?: int, enabled?: bool }` - Returns: `200 { printeragent: T8 }` ### Section: /printerjob #### List printer jobs — `GET /printerjob` - Params: `query: agentprinterId?: int, state?: str` - Returns: `200 { printerjobs: T16[] }` #### Create print job — `POST /printerjob` - Params: `body: { agentprinterId: int, data: str, type?: str }` - Returns: `201 { printerjob: T16 }` #### Cancel all pending and processing printer jobs — `POST /printerjob/cancel-all` - Params: `body?: { agentprinterId?: int }` - Returns: `200 { success: bool, cancelledCount: int, jobs: T16[] }` #### Cancel and delete printer job — `DELETE /printerjob/{id}` - Params: `id: int` - Returns: `200 { success: bool, deletedJob: T16 }` #### Get printer job — `GET /printerjob/{id}` - Params: `id: int` - Returns: `200 { printerjob: T16 }` #### Cancel printer job — `POST /printerjob/{id}/cancel` - Params: `id: int` - Returns: `200 { success: bool, printerjob: T16 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ - Returns: `200 { propertynames: T24[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` - Returns: `201 { propertyname: T24 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` #### Delete property name — `DELETE /propertyname/{id}` - Params: `id: int` - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` - Returns: `200 { propertyname: T24 }` ### Section: /quote #### List quotes — `GET /quote` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` - Params: `body: { number: str, date: str, lines: T15[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` - Returns: `204 void` #### Get quote — `GET /quote/{id}` - Params: `id: int` - Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` - Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }` - Returns: `200 { quote: T3 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Create order from quote — `POST /quote/{id}/order` - Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T15[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T7, fileUrl: str }` ### Section: /retoure #### List retoures — `GET /retoure` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, entityId?: int, seekMonths?: int` - Returns: `200` #### Create retoure — `POST /retoure` - Params: `body: { date: str, number?: str, entityId?: int, externalNumber?: str, lines?: any[] }` - Returns: `201` #### Rebuild retoure summaries — `POST /retoure/rebuild-summaries` _none_ - Returns: `200` #### Delete retoure — `DELETE /retoure/{id}` - Params: `id: int` - Returns: `204 void` #### Get retoure by ID — `GET /retoure/{id}` - Params: `id: int` - Returns: `200` #### Update retoure — `PUT /retoure/{id}` - Params: `id: int, body: {}` - Returns: `200` #### Create shipment for retoure — `POST /retoure/{id}/shipment` - Params: `id: int` - Returns: `201` ### Section: /return #### List returns — `GET /return` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int` - Returns: `200` #### Create return — `POST /return` - Params: `body: {}` - Returns: `201` #### Rebuild return summaries — `POST /return/rebuild-summaries` _none_ - Returns: `200` #### Delete return — `DELETE /return/{id}` - Params: `id: int` - Returns: `204 void` #### Get return by ID — `GET /return/{id}` - Params: `id: int` - Returns: `200` #### Update return — `PUT /return/{id}` - Params: `id: int` - Returns: `200` #### Book return to ledger — `POST /return/{id}/book` - Params: `id: int` - Returns: `200` ### Section: /shipment #### List shipments — `GET /shipment` - Params: `query: offset?: int, limit?: int, search?: str, state?: str, seekMonths?: int` - Returns: `200 { shipments: { id: int, number: str, type: str, date: str, positions: int, totalQuantity: num, packageCount: int, state: str, entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, orderId?: int|null, orderNumber?: str|null, customerName?: str|null, carrier?: str|null, trackingCode?: str|null }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Delete shipment — `DELETE /shipment/{id}` - Params: `id: int` - Returns: `204 void` #### Get shipment by ID — `GET /shipment/{id}` - Params: `id: int` - Returns: `200 { shipment: T2 }` #### Update shipment state or metadata — `PATCH /shipment/{id}` - Params: `id: int, body: { state?: str }` - Returns: `200 { shipment: T2 }` #### Delete shipment file attachment — `DELETE /shipment/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T7, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` - Returns: `200 { shippings: T17[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` - Returns: `201 { shipping: T17 }` ### Section: /shipping #### Delete shipping — `DELETE /shipping/{id}` - Params: `id: int` - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` - Returns: `200 { shipping: T17 }` #### List packages of a shipping — `GET /shipping/{id}/package` - Params: `id: int` - Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }` #### Create package for a shipping — `POST /shipping/{id}/package` - Params: `id: int, body: { entityaddressId: int, type: str, state: str, details?: str }` - Returns: `201 { package: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null } }` ### Section: /smallthumb #### Small thumb image by hash — `GET /smallthumb/{fullHash}` - Params: `fullHash: str` - Returns: `200 avif` ### Section: /stock #### Accept delivery manifest item(s) — `POST /stock/accept` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` #### Adjust stock manually — `POST /stock/adjust` - Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str|null, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }` - Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T12[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` ### Section: /subagentschedule #### List subagent schedules — `GET /subagentschedule` _none_ - Returns: `200 { schedules: T11[] }` #### Create subagent schedule — `POST /subagentschedule` - Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }` - Returns: `201 { schedule: T11 }` #### Delete subagent schedule — `DELETE /subagentschedule/{id}` - Params: `id: int` - Returns: `204 void` #### Get subagent schedule by ID — `GET /subagentschedule/{id}` - Params: `id: int` - Returns: `200 { schedule: T11 }` #### Update subagent schedule — `PUT /subagentschedule/{id}` - Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }` - Returns: `200 { schedule: T11 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ - Returns: `200 { suppliers: T29[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` - Returns: `201 { supplier: T29 }` #### Delete supplier — `DELETE /supplier/{id}` - Params: `id: int` - Returns: `204 void` #### Update supplier — `PATCH /supplier/{id}` - Params: `id: int, body: { name: str }` - Returns: `200 { supplier: T29 }` #### List supplier articles by SKUs — `GET /supplier/{id}/articles` - Params: `id: int, query: skus?: str` - Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` - Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /unit #### Delete unit — `DELETE /unit` - Params: `query: si: str` - Returns: `204 void` #### List units — `GET /unit` _none_ - Returns: `200 { units: T22[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` - Returns: `200 { unit: T22 }` ### Section: /v1 #### JTL-POS deleted entity synchronization — `GET /v1/deletedentity` - Params: `query: lastChangedDeletedEntity?: str, limit?: int` - Returns: `200 { entityId: str, entityType: int, lastChanged: int }[]` #### JTL-POS order upload — `POST /v1/order` - Params: `query: mandantId?: str, body: { orders?: {}[] }` - Returns: `200 { status: str, externalOrderId: str, message: str }[]` ### Section: /warehouse #### List warehouses — `GET /warehouse` _none_ - Returns: `200 { warehouses: { id: int, name: str, sort: int }[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` - Returns: `201 { warehouse: { id: int, name: str, sort: int } }` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` #### Delete warehouse — `DELETE /warehouse/{id}` - Params: `id: int` - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` - Returns: `200 { warehouse: { id: int, name: str, sort: int } }` #### Update warehouse (partial) — `PATCH /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` - Returns: `200 { warehouse: { id: int, name: str, sort: int } }` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` - Returns: `200 { warehouse: { id: int, name: str, sort: int } }` ### Section: /zpljob #### Create ZPL print job — `POST /zpljob` - Params: `body: { agentprinterId: int, data: str, copiescount?: int }` - Returns: `201 { printerjob: T16 }` ### Binary & streaming routes (reachable only via `fetch()` in javascript_execute) These routes are NOT in the table above because their payloads (binary request body or binary response) or long-lived streams cannot be handled usefully by the `dashback_request` tool. They ARE reachable from inside `javascript_execute` with `fetch("/route")`: | 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 }`. | `POST` | `/article/{sku}/image` | `201 { image: { picId, sort, full, thumb, hash, thumbHash } }` | Upload full-size AVIF or WebP image for article SKU. WebP is auto-converted to AVIF. Body: raw binary (`image/avif` or `image/webp`). | `POST` | `/attributevalue/{id}/image` | `201 { attributevalue: { id, fullHash, thumbW, thumbH, thumbHash, pics } }` | Upload or replace AVIF/WebP image for attribute value ID. Body: raw binary (`image/avif` or `image/webp`). | `POST` | `/brand/{id}/image` | `201 { brand: { id, fullHash, thumbW, thumbH, thumbHash, pics } }` | Upload or replace AVIF/WebP image for brand ID. Body: raw binary (`image/avif` or `image/webp`). | `POST` | `/category/{id}/image` | `201 { category: { id, thumbW, thumbH, thumbHash } }` | Upload or replace AVIF/WebP image for category ID. Body: raw binary (`image/avif` or `image/webp`). Save downloaded bytes to the VFS, then embed them in your reply as `![title](artifacts/thumb.avif)`: ```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 }; })(); ``` Upload an image from the VFS: ```js module.exports = (async () => { const buf = fs.readFileSync("images/product.avif"); const res = await fetch("/article/SKU123/image", { method: "POST", headers: { "Content-Type": "image/avif" }, body: buf, }); return await res.json(); })(); ``` `fullHash` appears on articles, brands and categories. `thumbHash` is a base64 blur-up placeholder, not a content hash, and is not accepted here.