From 988b4848cfaf58279cd6ded678726d5a21b964ad Mon Sep 17 00:00:00 2001 From: seb Date: Sat, 17 Oct 2026 03:08:18 +0200 Subject: [PATCH] u --- docs/api/routes-all.md | 351 ++++++++++++++++++------------------- docs/api/routes.md | 296 +++++++++++++++---------------- scripts/generateApiDocs.js | 39 ++++- 3 files changed, 341 insertions(+), 345 deletions(-) diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index f51716f..e675b18 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -9,63 +9,46 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ order: T2 }` -- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T31[], externalNumber?: str|null, createdAt?: str, shipping?: T38|null, shippings?: T38[], payment?: T44|null, payments?: T44[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T16[] }` -- `T3` = `{ article: T4 }` -- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T41, brand: T39|null, categoryIds: int[], photos: T36[], eans: str[], prices: T48[], suppliers: T18[] }` -- `T5` = `{ shipment: T6 }` -- `T6` = `{ id: int, number: str, type: str, date: str, lines: T31[], shippings: T38[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T16[], state?: str }` -- `T7` = `{ quote: T8 }` -- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T31[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T16[] }` -- `T9` = `{ delivery: T10 }` -- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T31[], files: T16[], externalNumber?: str|null, createdAt?: str, ledger?: T52 }` -- `T11` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T12|null }` -- `T12` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T19, totalSizeBytes: int, durationMs: int }` -- `T13` = `{ labeltemplate: T15 }` -- `T14` = `{ attachment: T16, fileUrl: str }` -- `T15` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T28, thumb?: str|null }` -- `T16` = `{ 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 }` -- `T17` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }` -- `T18` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T55|null }` -- `T19` = `{ vfs: T53, storage: T53, database: T46 }` -- `T20` = `{ schedule: T23 }` -- `T21` = `{ 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 }` -- `T22` = `{ ledger: T24[] }` -- `T23` = `{ 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 }` -- `T24` = `{ 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 }` -- `T25` = `{ id: int, name: str, sort: int, exclusive: bool, values: T42[], articleCount?: int }` -- `T26` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }` -- `T27` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` -- `T28` = `{ objects: T32[] }` -- `T29` = `{ printer: T34 }` -- `T30` = `{ entity: T37 }` -- `T31` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T32` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T33` = `{ shipping: T38 }` -- `T34` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T35` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T36` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T37` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T38` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T39` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T40` = `{ article: T45 }` -- `T41` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T42` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T43` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T44` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T45` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T46` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T47` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T48` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T49` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T50` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T51` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T52` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T53` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T54` = `{ warehouse: T56 }` -- `T55` = `{ net: num, taxId: int, taxRate?: num|null }` -- `T56` = `{ id: int, name: str, sort: int }` -- `T57` = `{ id: int, categoryIds: int[] }` +- `T1` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T19[], externalNumber?: str|null, createdAt?: str, shipping?: T25|null, shippings?: T25[], payment?: T30|null, payments?: T30[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T3[], files?: T9[] }` +- `T2` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T27, brand: T26|null, categoryIds: int[], photos: T23[], eans: str[], prices: T34[], suppliers: T11[] }` +- `T3` = `{ id: int, number: str, type: str, date: str, lines: T19[], shippings: T25[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T9[], state?: str }` +- `T4` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T19[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T9[] }` +- `T5` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T19[], files: T9[], externalNumber?: str|null, createdAt?: str, ledger?: T38 }` +- `T6` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T7|null }` +- `T7` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T12, totalSizeBytes: int, durationMs: int }` +- `T8` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T20[] }, thumb?: str|null }` +- `T9` = `{ 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 }` +- `T10` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }` +- `T11` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null }` +- `T12` = `{ vfs: T39, storage: T39, database: T32 }` +- `T13` = `{ 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 }` +- `T14` = `{ 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 }` +- `T15` = `{ 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 }` +- `T16` = `{ id: int, name: str, sort: int, exclusive: bool, values: T28[], articleCount?: int }` +- `T17` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }` +- `T18` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` +- `T19` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T20` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T21` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T22` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T23` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T24` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T25` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T26` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T27` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T28` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T29` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T30` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T31` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` +- `T32` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T33` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T34` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` +- `T35` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T36` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T37` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T38` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T39` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T40` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -95,7 +78,7 @@ _none_ #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 T40` +- Returns: `201 { article: T31 }` #### Export articles as ZIP — `GET /article/export.zip` - Params: `query: categoryId?: int` - Returns: `200 zip` @@ -104,10 +87,10 @@ _none_ - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` #### 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: `200 T3` +- Returns: `200 { article: T2 }` #### 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 }[] }` @@ -122,25 +105,25 @@ _none_ - 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: `200 T3` +- Returns: `200 { article: T2 }` #### Replace article categories by SKU — `PUT /article/{sku}/categories` - Params: `sku: str, body: { categoryIds: int[] }` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` #### 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 T40` +- Returns: `201 { article: T31 }` #### 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 { article: T45, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T31, 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: `200 T3` +- Returns: `200 { article: T2 }` #### Get article history by SKU — `GET /article/{sku}/history` - Params: `sku: str, query: limit?: int` - Returns: `200 { history: { id: int, date: str, text: str }[], truncated: bool }` @@ -161,10 +144,10 @@ _none_ - 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: `200 T40` +- Returns: `200 { article: T31 }` #### 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: `200 T3` +- Returns: `200 { article: T2 }` #### Print article label — `POST /article/{sku}/print` - Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }` - Returns: `200 { success: bool }` @@ -179,10 +162,10 @@ _none_ - Returns: `200 { ok: bool }` #### List article suppliers — `GET /article/{sku}/supplier` - Params: `sku: str` -- Returns: `200 { suppliers: T18[] }` +- Returns: `200 { suppliers: T11[] }` #### 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: T18 }` +- Returns: `201 { supplier: T11 }` #### Reorder article suppliers — `PUT /article/{sku}/supplier/order` - Params: `sku: str, body: { ids: int[] }` - Returns: `200 { ids: int[] }` @@ -191,31 +174,31 @@ _none_ - 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: T18 }` +- Returns: `200 { supplier: T11 }` #### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock` - Params: `sku: str, body: { track_stock: bool }` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` #### Set article weight by SKU — `PUT /article/{sku}/weight` - Params: `sku: str, body: { weight: num }` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` ### Section: /attributename #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T25[] }` +- Returns: `200 { attributenames: T16[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T25 }` +- Returns: `201 { attributename: T16 }` #### 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: T42[] }` +- Returns: `200 { values: T28[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T42 }` +- Returns: `201 { attributevalue: T28 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -224,7 +207,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute name — `PATCH /attributename/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { attributename: T25 }` +- Returns: `200 { attributename: T16 }` ### Section: /attributevalue @@ -233,34 +216,34 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T42 }` +- Returns: `200 { attributevalue: T28 }` #### 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: T49[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T35[] } }` #### Add or replace attribute value image — `POST /attributevalue/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T49[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T35[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T47 }` +- Returns: `200 { message: str, user: T33 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T47, googleClientId: str }` +- Returns: `200 { user: T33, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T47 }` +- Returns: `200 { user: T33 }` ### Section: /backup #### List backups and service status — `GET /backup` _none_ -- Returns: `200 { status: { enabled: bool, isRunning: bool, dbProvider: str, mssqlWarning: bool, backupDir: str, retention: { hourlyMax: int, dailyMax: int, monthly: str }, counts: { hourly: int, daily: int, monthly: int }, latestHourly?: T11|null, latestDaily?: T11|null, latestMonthly?: T11|null }, backups: { counts: { hourly: int, daily: int, monthly: int }, hourly: T11[], daily: T11[], monthly: T11[] } }` +- Returns: `200 { status: { enabled: bool, isRunning: bool, dbProvider: str, mssqlWarning: bool, backupDir: str, retention: { hourlyMax: int, dailyMax: int, monthly: str }, counts: { hourly: int, daily: int, monthly: int }, latestHourly?: T6|null, latestDaily?: T6|null, latestMonthly?: T6|null }, backups: { counts: { hourly: int, daily: int, monthly: int }, hourly: T6[], daily: T6[], monthly: T6[] } }` #### List VFS files in a backup — `GET /backup/{id}/vfs` - Params: `id: str, query: companyId?: int` - Returns: `200 { backupId: str, companyId: int, files: { name: str, size: int, mime: str, mtime: str }[] }` @@ -275,7 +258,7 @@ _none_ - 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: T49[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T35[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -284,10 +267,10 @@ _none_ - 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: T49[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T35[] } }` #### Add or replace brand image — `POST /brand/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T49[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T35[] } }` ### Section: /category @@ -311,7 +294,7 @@ _none_ - Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }` #### Articles in category — `GET /category/{id}/articles` - Params: `id: int` -- 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, brand?: T39|null }[] }` +- 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, brand?: T26|null }[] }` #### 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 }[] }` @@ -338,10 +321,10 @@ _none_ #### List companies — `GET /company` _none_ -- Returns: `200 { companies: T27[] }` +- Returns: `200 { companies: T18[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T27, user: T47 }` +- Returns: `201 { company: T18, user: T33 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -371,7 +354,7 @@ _none_ - Returns: `204 void` #### Update company — `PUT /company/{id}` - Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `200 { company: T27 }` +- Returns: `200 { company: T18 }` ### Section: /customergroup @@ -380,7 +363,7 @@ _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` -- Returns: `201 { customergroup: T56 }` +- Returns: `201 { customergroup: { id: int, name: str, sort: int } }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` @@ -389,25 +372,25 @@ _none_ - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { customergroup: T56 }` +- 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|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T52 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T38 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T35[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `201 T9` +- Params: `body: { externalNumber: str, date: str, lines: T22[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Returns: `201 { delivery: T5 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` - Returns: `204 void` #### Get delivery — `GET /delivery/{id}` - Params: `id: int` -- Returns: `200 T9` +- Returns: `200 { delivery: T5 }` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T35[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `200 T9` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T22[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Returns: `200 { delivery: T5 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -416,52 +399,52 @@ _none_ - Returns: `200 str` #### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf` - Params: `id: int` -- Returns: `201 T14` +- Returns: `201 { attachment: T9, fileUrl: str }` ### Section: /entity #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T37[] }` +- Returns: `200 { entities: T24[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 T30` +- Returns: `201 { entity: T24 }` #### 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: T21[] }` +- Returns: `200 { addresses: T13[] }` #### 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: T21 }` +- Returns: `201 { address: T13 }` #### 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: T21 }` +- Returns: `200 { address: T13 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T50[] }` +- Returns: `200 { contacts: T36[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T50 }` +- Returns: `201 { contact: T36 }` #### 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: T50 }` +- Returns: `200 { contact: T36 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 T30` +- Returns: `200 { entity: T24 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 T30` +- Returns: `200 { entity: T24 }` ### Section: /events @@ -503,32 +486,32 @@ _none_ _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: T28 }` -- Returns: `201 T13` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T20[] } }` +- Returns: `201 { labeltemplate: T8 }` #### 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 T13` +- Returns: `200 { labeltemplate: T8 }` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T28 }` -- Returns: `200 T13` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T20[] } }` +- Returns: `200 { labeltemplate: T8 }` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T28 }` -- Returns: `200 T13` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T20[] } }` +- Returns: `200 { labeltemplate: T8 }` ### Section: /ledger #### Query ledger by manifest article ID or SKU — `GET /ledger` - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str` -- Returns: `200 T22` +- Returns: `200 { ledger: T15[] }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 T22` +- Returns: `200 { ledger: T15[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 T22` +- Returns: `200 { ledger: T15[] }` ### Section: /mcp @@ -558,16 +541,16 @@ _none_ #### List conversations — `GET /modelconversation` _none_ -- Returns: `200 { conversations: T26[] }` +- Returns: `200 { conversations: T17[] }` #### Create conversation — `POST /modelconversation` - Params: `body: { provider: str, model: str }` -- Returns: `201 { conversation: T26 }` +- Returns: `201 { conversation: T17 }` #### Delete conversation — `DELETE /modelconversation/{id}` - Params: `id: int` - Returns: `204 void` #### Get conversation — `GET /modelconversation/{id}` - Params: `id: int` -- Returns: `200 { conversation: T26 }` +- Returns: `200 { conversation: T17 }` #### List conversation messages — `GET /modelconversation/{id}/message` - Params: `id: int` - Returns: `200 { messages: { id: int, conversation_id: int, created_at: str, role: str, message: str }[] }` @@ -606,19 +589,19 @@ _none_ #### List orders — `GET /order` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` -- Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, lines: T35[], entityId?: int|null, externalNumber?: str|null }` -- Returns: `201 T1` +- Params: `body: { number: str, date: str, lines: T22[], entityId?: int|null, 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 T1` +- Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` -- Returns: `200 T1` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T22[] }` +- Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -627,25 +610,25 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T44[] }` +- Returns: `200 { payments: T30[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T44 }` +- Returns: `201 { payment: T30 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` -- Returns: `201 T14` +- Returns: `201 { attachment: T9, fileUrl: str }` #### List shipments of an order — `GET /order/{id}/shipment` - Params: `id: int` -- Returns: `200 { shipments: T6[] }` +- Returns: `200 { shipments: T3[] }` #### Create shipment for an order — `POST /order/{id}/shipment` - Params: `id: int, body?: { date?: str, externalNumber?: str, lines?: { sku: str, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[] }` -- Returns: `201 T5` +- Returns: `201 { shipment: T3 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T38[] }` +- Returns: `200 { shippings: T25[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 T33` +- Returns: `201 { shipping: T25 }` ### Section: /package @@ -663,37 +646,37 @@ _none_ #### List POS terminals — `GET /posterminal` _none_ -- Returns: `200 { posterminals: T17[] }` +- Returns: `200 { posterminals: T10[] }` #### Create POS terminal — `PUT /posterminal` - Params: `body: { name: str, rootCategoryId?: int|null, syncRootArticles?: bool }` -- Returns: `200 { posterminal: T17 }` +- Returns: `200 { posterminal: T10 }` #### Delete POS terminal — `DELETE /posterminal/{id}` - Params: `id: int` - Returns: `204 void` #### Update POS terminal — `PATCH /posterminal/{id}` - Params: `id: int, body: { name?: str, rootCategoryId?: int|null, syncRootArticles?: bool, pairingpin?: str|null }` -- Returns: `200 { posterminal: T17 }` +- Returns: `200 { posterminal: T10 }` #### Disable all categories on terminal — `DELETE /posterminal/{id}/all` - Params: `id: int` -- Returns: `200 T57` +- Returns: `200 { id: int, categoryIds: int[] }` #### Enable all categories on terminal — `PUT /posterminal/{id}/all` - Params: `id: int` -- Returns: `200 T57` +- Returns: `200 { id: int, categoryIds: int[] }` #### Disable category on terminal — `DELETE /posterminal/{id}/category/{categoryId}` - Params: `id: int, categoryId: int` -- Returns: `200 T57` +- Returns: `200 { id: int, categoryIds: int[] }` #### Enable category on terminal — `PUT /posterminal/{id}/category/{categoryId}` - Params: `id: int, categoryId: int` -- Returns: `200 T57` +- Returns: `200 { id: int, categoryIds: int[] }` ### Section: /printer #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T34[] }` +- Returns: `200 { printers: T21[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 T29` +- Returns: `201 { printer: T21 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -702,22 +685,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 T29` +- Returns: `200 { printer: T21 }` #### 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 T29` +- Returns: `200 { printer: T21 }` #### 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 T29` +- Returns: `200 { printer: T21 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T43[] }` +- Returns: `200 { propertynames: T29[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T43 }` +- Returns: `201 { propertyname: T29 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -726,7 +709,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { propertyname: T43 }` +- Returns: `200 { propertyname: T29 }` ### Section: /public @@ -738,7 +721,7 @@ _none_ - Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, net: num|null, taxRate: num|null, gross: num|null, trackStock: bool, brand: { id: int|null, name: str }, fullHash: str|null, thumbW: int|null, thumbH: int|null, thumbHash: str|null }[] }` #### Get public article detail — `GET /public/{companyId}/articles/{sku}` - Params: `companyId: int, sku: str` -- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T41|null, brand: T39|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: T36[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T27|null, brand: T26|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: T23[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }` #### List public categories — `GET /public/{companyId}/categories` - Params: `companyId: int` - Returns: `200 { categories: { id: int, parentId: int|null, sort: int, name: str, slug: str, fullHash: str|null, thumbW: int|null, thumbH: int|null, thumbHash: str|null }[] }` @@ -747,19 +730,19 @@ _none_ #### List quotes — `GET /quote` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` -- Returns: `200 { quotes: T8[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { quotes: T4[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T35[], entityId?: int|null, externalNumber?: str|null }` -- Returns: `201 T7` +- Params: `body: { number: str, date: str, lines: T22[], entityId?: int|null, externalNumber?: str|null }` +- Returns: `201 { quote: T4 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` - Returns: `204 void` #### Get quote — `GET /quote/{id}` - Params: `id: int` -- Returns: `200 T7` +- Returns: `200 { quote: T4 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` -- Returns: `200 T7` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T22[] }` +- Returns: `200 { quote: T4 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -767,11 +750,11 @@ _none_ - Params: `id: int, fileId: int, query: download?: bool` - Returns: `200 str` #### 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?: T35[] }` -- Returns: `201 T1` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T22[] }` +- Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` -- Returns: `201 T14` +- Returns: `201 { attachment: T9, fileUrl: str }` ### Section: /serper @@ -798,10 +781,10 @@ _none_ - Returns: `204 void` #### Get shipment by ID — `GET /shipment/{id}` - Params: `id: int` -- Returns: `200 T5` +- Returns: `200 { shipment: T3 }` #### Update shipment state or metadata — `PATCH /shipment/{id}` - Params: `id: int, body: { state?: str }` -- Returns: `200 T5` +- Returns: `200 { shipment: T3 }` #### Delete shipment file attachment — `DELETE /shipment/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -810,13 +793,13 @@ _none_ - Returns: `200 str` #### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf` - Params: `id: int` -- Returns: `201 T14` +- Returns: `201 { attachment: T9, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T38[] }` +- Returns: `200 { shippings: T25[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 T33` +- Returns: `201 { shipping: T25 }` ### Section: /shipping @@ -825,7 +808,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 T33` +- Returns: `200 { shipping: T25 }` #### 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 }[] }` @@ -846,7 +829,7 @@ _none_ - 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: T24[] }` +- 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: T15[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` @@ -855,40 +838,40 @@ _none_ #### List subagent schedules — `GET /subagentschedule` _none_ -- Returns: `200 { schedules: T23[] }` +- Returns: `200 { schedules: T14[] }` #### 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 T20` +- Returns: `201 { schedule: T14 }` #### 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 T20` +- Returns: `200 { schedule: T14 }` #### 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 T20` +- Returns: `200 { schedule: T14 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T51[] }` +- Returns: `200 { suppliers: T37[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T51 }` +- Returns: `201 { supplier: T37 }` #### 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: T51 }` +- Returns: `200 { supplier: T37 }` #### 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?: T55|null }[] }` +- 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?: T40|null }[] }` #### 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?: T55|null }[] }` +- 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?: T40|null }[] }` ### Section: /thumb @@ -903,10 +886,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T41[] }` +- Returns: `200 { units: T27[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T41 }` +- Returns: `200 { unit: T27 }` ### Section: /v1 @@ -963,10 +946,10 @@ _none_ #### List warehouses — `GET /warehouse` _none_ -- Returns: `200 { warehouses: T56[] }` +- Returns: `200 { warehouses: { id: int, name: str, sort: int }[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` -- Returns: `201 T54` +- Returns: `201 { warehouse: { id: int, name: str, sort: int } }` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` @@ -975,10 +958,10 @@ _none_ - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` -- Returns: `200 T54` +- 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 T54` +- Returns: `200 { warehouse: { id: int, name: str, sort: int } }` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T54` +- Returns: `200 { warehouse: { id: int, name: str, sort: int } }` diff --git a/docs/api/routes.md b/docs/api/routes.md index e9c6629..7a1d0d2 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -9,53 +9,37 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ order: T2 }` -- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T25[], externalNumber?: str|null, createdAt?: str, shipping?: T32|null, shippings?: T32[], payment?: T38|null, payments?: T38[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T14[] }` -- `T3` = `{ article: T4 }` -- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T35, brand: T33|null, categoryIds: int[], photos: T30[], eans: str[], prices: T40[], suppliers: T15[] }` -- `T5` = `{ shipment: T6 }` -- `T6` = `{ id: int, number: str, type: str, date: str, lines: T25[], shippings: T32[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T14[], state?: str }` -- `T7` = `{ quote: T8 }` -- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T25[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T14[] }` -- `T9` = `{ delivery: T10 }` -- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T25[], files: T14[], externalNumber?: str|null, createdAt?: str, ledger?: T44 }` -- `T11` = `{ labeltemplate: T13 }` -- `T12` = `{ attachment: T14, fileUrl: str }` -- `T13` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T22, thumb?: str|null }` -- `T14` = `{ 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 }` -- `T15` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T46|null }` -- `T16` = `{ schedule: T19 }` -- `T17` = `{ 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 }` -- `T18` = `{ ledger: T20[] }` -- `T19` = `{ 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 }` -- `T20` = `{ 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 }` -- `T21` = `{ id: int, name: str, sort: int, exclusive: bool, values: T36[], articleCount?: int }` -- `T22` = `{ objects: T26[] }` -- `T23` = `{ printer: T28 }` -- `T24` = `{ entity: T31 }` -- `T25` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T26` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T27` = `{ shipping: T32 }` -- `T28` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T29` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T30` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T31` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T32` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T33` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T34` = `{ article: T39 }` -- `T35` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T36` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T37` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T38` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T39` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T40` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T41` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T42` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T43` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T44` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T45` = `{ warehouse: T47 }` -- `T46` = `{ net: num, taxId: int, taxRate?: num|null }` -- `T47` = `{ id: int, name: str, sort: int }` +- `T1` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, shipping?: T19|null, shippings?: T19[], payment?: T24|null, payments?: T24[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T3[], files?: T7[] }` +- `T2` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T21, brand: T20|null, categoryIds: int[], photos: T17[], eans: str[], prices: T26[], suppliers: T8[] }` +- `T3` = `{ id: int, number: str, type: str, date: str, lines: T13[], shippings: T19[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }` +- `T4` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` +- `T5` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T13[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T30 }` +- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T14[] }, 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, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null }` +- `T9` = `{ 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 }` +- `T10` = `{ 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 }` +- `T11` = `{ 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 }` +- `T12` = `{ id: int, name: str, sort: int, exclusive: bool, values: T22[], articleCount?: int }` +- `T13` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T14` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T15` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T16` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T17` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T18` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T19` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T20` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T21` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T22` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T24` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T25` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` +- `T26` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` +- `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 @@ -64,16 +48,16 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 T34` +- Returns: `201 { article: T25 }` #### 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 T3` +- Returns: `200 { article: T2 }` #### 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: `200 T3` +- Returns: `200 { article: T2 }` #### 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 }[] }` @@ -88,25 +72,25 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - 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: `200 T3` +- Returns: `200 { article: T2 }` #### Replace article categories by SKU — `PUT /article/{sku}/categories` - Params: `sku: str, body: { categoryIds: int[] }` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` #### 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 T34` +- Returns: `201 { article: T25 }` #### 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 { article: T39, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T25, 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: `200 T3` +- Returns: `200 { article: T2 }` #### Get article history by SKU — `GET /article/{sku}/history` - Params: `sku: str, query: limit?: int` - Returns: `200 { history: { id: int, date: str, text: str }[], truncated: bool }` @@ -124,10 +108,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - 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: `200 T34` +- Returns: `200 { article: T25 }` #### 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: `200 T3` +- Returns: `200 { article: T2 }` #### Print article label — `POST /article/{sku}/print` - Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }` - Returns: `200 { success: bool }` @@ -142,10 +126,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - Returns: `200 { ok: bool }` #### List article suppliers — `GET /article/{sku}/supplier` - Params: `sku: str` -- Returns: `200 { suppliers: T15[] }` +- Returns: `200 { suppliers: T8[] }` #### 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: T15 }` +- Returns: `201 { supplier: T8 }` #### Reorder article suppliers — `PUT /article/{sku}/supplier/order` - Params: `sku: str, body: { ids: int[] }` - Returns: `200 { ids: int[] }` @@ -154,31 +138,31 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - 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: T15 }` +- Returns: `200 { supplier: T8 }` #### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock` - Params: `sku: str, body: { track_stock: bool }` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` #### Set article weight by SKU — `PUT /article/{sku}/weight` - Params: `sku: str, body: { weight: num }` -- Returns: `200 T3` +- Returns: `200 { article: T2 }` ### Section: /attributename #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T21[] }` +- Returns: `200 { attributenames: T12[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T21 }` +- Returns: `201 { attributename: T12 }` #### 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: T36[] }` +- Returns: `200 { values: T22[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T36 }` +- Returns: `201 { attributevalue: T22 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -187,7 +171,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute name — `PATCH /attributename/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { attributename: T21 }` +- Returns: `200 { attributename: T12 }` ### Section: /attributevalue @@ -196,13 +180,13 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T36 }` +- Returns: `200 { attributevalue: T22 }` #### 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: T41[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` #### Add or replace attribute value image — `POST /attributevalue/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T41[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T27[] } }` ### Section: /brand @@ -211,7 +195,7 @@ _none_ - 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: T41[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T27[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -220,10 +204,10 @@ _none_ - 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: T41[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` #### Add or replace brand image — `POST /brand/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T41[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T27[] } }` ### Section: /category @@ -244,7 +228,7 @@ _none_ - Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }` #### Articles in category — `GET /category/{id}/articles` - Params: `id: int` -- 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, brand?: T33|null }[] }` +- 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, brand?: T20|null }[] }` #### 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 }[] }` @@ -298,7 +282,7 @@ _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` -- Returns: `201 { customergroup: T47 }` +- Returns: `201 { customergroup: { id: int, name: str, sort: int } }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` @@ -307,76 +291,76 @@ _none_ - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { customergroup: T47 }` +- 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|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T44 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, 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, lines: T29[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `201 T9` +- Params: `body: { externalNumber: str, date: str, lines: T16[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Returns: `201 { delivery: T5 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` - Returns: `204 void` #### Get delivery — `GET /delivery/{id}` - Params: `id: int` -- Returns: `200 T9` +- Returns: `200 { delivery: T5 }` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T29[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `200 T9` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T16[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Returns: `200 { delivery: T5 }` #### 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 T12` +- Returns: `201 { attachment: T7, fileUrl: str }` ### Section: /entity #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T31[] }` +- Returns: `200 { entities: T18[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 T24` +- Returns: `201 { entity: T18 }` #### 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: T17[] }` +- Returns: `200 { addresses: T9[] }` #### 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: T17 }` +- Returns: `201 { address: T9 }` #### 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: T17 }` +- Returns: `200 { address: T9 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T42[] }` +- Returns: `200 { contacts: T28[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T42 }` +- 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: T42 }` +- 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 T24` +- Returns: `200 { entity: T18 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 T24` +- Returns: `200 { entity: T18 }` ### Section: /labeltemplate @@ -384,32 +368,32 @@ _none_ _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: T22 }` -- Returns: `201 T11` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T14[] } }` +- Returns: `201 { labeltemplate: T6 }` #### 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 T11` +- 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?: T22 }` -- Returns: `200 T11` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T14[] } }` +- 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?: T22 }` -- Returns: `200 T11` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T14[] } }` +- 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 T18` +- Returns: `200 { ledger: T11[] }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 T18` +- Returns: `200 { ledger: T11[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 T18` +- Returns: `200 { ledger: T11[] }` ### Section: /number @@ -424,43 +408,43 @@ _none_ #### List orders — `GET /order` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` -- Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, lines: T29[], entityId?: int|null, externalNumber?: str|null }` -- Returns: `201 T1` +- Params: `body: { number: str, date: str, lines: T16[], entityId?: int|null, 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 T1` +- Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` -- Returns: `200 T1` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T16[] }` +- 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: T38[] }` +- Returns: `200 { payments: T24[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T38 }` +- Returns: `201 { payment: T24 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` -- Returns: `201 T12` +- Returns: `201 { attachment: T7, fileUrl: str }` #### List shipments of an order — `GET /order/{id}/shipment` - Params: `id: int` -- Returns: `200 { shipments: T6[] }` +- Returns: `200 { shipments: T3[] }` #### Create shipment for an order — `POST /order/{id}/shipment` - Params: `id: int, body?: { date?: str, externalNumber?: str, lines?: { sku: str, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[] }` -- Returns: `201 T5` +- Returns: `201 { shipment: T3 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T32[] }` +- Returns: `200 { shippings: T19[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 T27` +- Returns: `201 { shipping: T19 }` ### Section: /package @@ -478,10 +462,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T28[] }` +- Returns: `200 { printers: T15[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 T23` +- Returns: `201 { printer: T15 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -490,22 +474,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 T23` +- Returns: `200 { printer: T15 }` #### 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 T23` +- Returns: `200 { printer: T15 }` #### 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 T23` +- Returns: `200 { printer: T15 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T37[] }` +- Returns: `200 { propertynames: T23[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T37 }` +- Returns: `201 { propertyname: T23 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -514,34 +498,34 @@ _none_ - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { propertyname: T37 }` +- Returns: `200 { propertyname: T23 }` ### Section: /quote #### List quotes — `GET /quote` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` -- Returns: `200 { quotes: T8[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { quotes: T4[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T29[], entityId?: int|null, externalNumber?: str|null }` -- Returns: `201 T7` +- Params: `body: { number: str, date: str, lines: T16[], entityId?: int|null, externalNumber?: str|null }` +- Returns: `201 { quote: T4 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` - Returns: `204 void` #### Get quote — `GET /quote/{id}` - Params: `id: int` -- Returns: `200 T7` +- Returns: `200 { quote: T4 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` -- Returns: `200 T7` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T16[] }` +- Returns: `200 { quote: T4 }` #### 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?: T29[] }` -- Returns: `201 T1` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T16[] }` +- Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` -- Returns: `201 T12` +- Returns: `201 { attachment: T7, fileUrl: str }` ### Section: /shipment @@ -553,22 +537,22 @@ _none_ - Returns: `204 void` #### Get shipment by ID — `GET /shipment/{id}` - Params: `id: int` -- Returns: `200 T5` +- Returns: `200 { shipment: T3 }` #### Update shipment state or metadata — `PATCH /shipment/{id}` - Params: `id: int, body: { state?: str }` -- Returns: `200 T5` +- Returns: `200 { shipment: T3 }` #### 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 T12` +- Returns: `201 { attachment: T7, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T32[] }` +- Returns: `200 { shippings: T19[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 T27` +- Returns: `201 { shipping: T19 }` ### Section: /shipping @@ -577,7 +561,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 T27` +- Returns: `200 { shipping: T19 }` #### 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 }[] }` @@ -598,7 +582,7 @@ _none_ - 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: T20[] }` +- 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: T11[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` @@ -607,40 +591,40 @@ _none_ #### List subagent schedules — `GET /subagentschedule` _none_ -- Returns: `200 { schedules: T19[] }` +- Returns: `200 { schedules: T10[] }` #### 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 T16` +- Returns: `201 { schedule: T10 }` #### 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 T16` +- Returns: `200 { schedule: T10 }` #### 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 T16` +- Returns: `200 { schedule: T10 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T43[] }` +- Returns: `200 { suppliers: T29[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T43 }` +- 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: T43 }` +- 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?: T46|null }[] }` +- 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 }[] }` #### 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?: T46|null }[] }` +- 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 }[] }` ### Section: /unit @@ -649,19 +633,19 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T35[] }` +- Returns: `200 { units: T21[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T35 }` +- Returns: `200 { unit: T21 }` ### Section: /warehouse #### List warehouses — `GET /warehouse` _none_ -- Returns: `200 { warehouses: T47[] }` +- Returns: `200 { warehouses: { id: int, name: str, sort: int }[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` -- Returns: `201 T45` +- Returns: `201 { warehouse: { id: int, name: str, sort: int } }` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` @@ -670,13 +654,13 @@ _none_ - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` -- Returns: `200 T45` +- 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 T45` +- Returns: `200 { warehouse: { id: int, name: str, sort: int } }` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T45` +- Returns: `200 { warehouse: { id: int, name: str, sort: int } }` ### 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: diff --git a/scripts/generateApiDocs.js b/scripts/generateApiDocs.js index 5d40fd3..df69003 100644 --- a/scripts/generateApiDocs.js +++ b/scripts/generateApiDocs.js @@ -684,17 +684,46 @@ function collectSchemaAliases(operations) { } } - const candidates = [...shapes.entries()] - .filter(([, item]) => item.count >= 3 && item.shape.length >= 36) - .sort((a, b) => b[1].shape.length - a[1].shape.length || a[0].localeCompare(b[0])); + let candidates = [...shapes.values()] + .filter((item) => item.count >= 3 && item.shape.length >= 36) + .sort((a, b) => b.shape.length - a.shape.length || a.shape.localeCompare(b.shape)); + + const isShort = (item, rendered) => { + const propCount = Object.keys(item.schema.properties || {}).length; + if (propCount <= 1) return true; + if (rendered.length < 36) return true; + return false; + }; + + while (true) { + const aliases = new Map(); + aliases.compactTypes = true; + for (let i = 0; i < candidates.length; i++) { + aliases.set(candidates[i].shape, `T${i + 1}`); + } + + const filtered = []; + let droppedAny = false; + for (const item of candidates) { + const rendered = summarizeSchema(item.schema, spec.components, 0, item.markOptional, aliases, true); + if (isShort(item, rendered)) { + droppedAny = true; + } else { + filtered.push(item); + } + } + candidates = filtered; + if (!droppedAny) break; + } + const aliases = new Map(); + aliases.compactTypes = true; const definitions = []; - for (const [, item] of candidates) { + for (const item of candidates) { const alias = `T${definitions.length + 1}`; aliases.set(item.shape, alias); definitions.push({ alias, ...item }); } - aliases.compactTypes = true; return { aliases, definitions }; }