From b7058df5d20eff7b3abee305f234c0f8c1266f3b Mon Sep 17 00:00:00 2001 From: seb Date: Tue, 20 Oct 2026 23:21:48 +0200 Subject: [PATCH] u --- docs/api/routes-all.md | 309 +++++++++--------- docs/api/routes.md | 258 +++++++-------- docs/api/routes/article/_sku/children.post.md | 8 +- docs/api/routes/article/_sku/children.put.md | 9 +- docs/api/routes/article/_sku/parent.md | 16 +- docs/api/routes/article/_sku/track_stock.md | 94 +----- docs/api/routes/article/create.md | 8 +- docs/api/routes/article/set-brand.md | 94 +----- docs/api/routes/article/set-categories.md | 94 +----- docs/api/routes/article/set-eans.md | 94 +----- docs/api/routes/article/set-prices.md | 94 +----- docs/api/routes/article/set-weight.md | 94 +----- docs/api/routes/article/update.md | 94 +----- src/api/routes/article/attributes.js | 90 ++--- src/api/routes/article/crud.js | 25 +- src/api/routes/article/variants.js | 27 +- 16 files changed, 345 insertions(+), 1063 deletions(-) diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index f59dec9..0776f1e 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -9,48 +9,43 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T20[], externalNumber?: str|null, createdAt?: str, shipping?: T19|null, shippings?: T19[], payment?: T31|null, payments?: T31[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T3[], files?: T10[] }` -- `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: T28, brand: T26|null, categoryIds: int[], photos: T24[], eans: str[], prices: T36[], suppliers: T8[], undeliveredOrders: T27[] }` -- `T3` = `{ id: int, number: str, type: str, date: str, lines: T20[], shippings: T19[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T10[], state?: str }` -- `T4` = `{ id: int, number: str, type: str, date: str, lines: T20[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T10[] }` -- `T5` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T20[], files: T10[], externalNumber?: str|null, createdAt?: str, ledger?: T40 }` -- `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, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T42|null, incoming?: { date: str, amount: num }[] }` -- `T9` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T21[] }, thumb?: str|null }` -- `T10` = `{ 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 }` -- `T11` = `{ 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[] }` -- `T12` = `{ vfs: T41, storage: T41, database: T34 }` -- `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: T29[], 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, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T20` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T21` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T22` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T23` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T24` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T25` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T26` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T27` = `{ orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }` -- `T28` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T29` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T30` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T31` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T32` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` -- `T33` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T34` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T35` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T36` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T37` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T38` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T39` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T40` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T41` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T42` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T19[], externalNumber?: str|null, createdAt?: str, shipping?: T18|null, shippings?: T18[], payment?: T28|null, payments?: T28[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T9[] }` +- `T2` = `{ id: int, number: str, type: str, date: str, lines: T19[], shippings: T18[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T9[], state?: str }` +- `T3` = `{ id: int, number: str, type: str, date: str, lines: T19[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T9[] }` +- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T19[], files: T9[], externalNumber?: str|null, createdAt?: str, ledger?: T35 }` +- `T5` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T6|null }` +- `T6` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T11, totalSizeBytes: int, durationMs: int }` +- `T7` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T37|null, incoming?: { date: str, amount: num }[] }` +- `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` = `{ vfs: T36, storage: T36, database: T30 }` +- `T12` = `{ 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 }` +- `T13` = `{ 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 }` +- `T14` = `{ 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 }` +- `T15` = `{ id: int, name: str, sort: int, exclusive: bool, values: T26[], articleCount?: int }` +- `T16` = `{ 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 }` +- `T17` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` +- `T18` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `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` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T24` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T25` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T26` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T27` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T28` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T29` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T30` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T31` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T32` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T33` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T34` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T35` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T36` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T37` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -80,7 +75,7 @@ _none_ #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 { article: T33 }` +- Returns: `201 { sku: str }` #### Export articles as ZIP — `GET /article/export.zip` - Params: `query: categoryId?: int` - Returns: `200 zip` @@ -92,10 +87,10 @@ _none_ - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` -- Returns: `200 { article: T2 }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T25, brand: T24|null, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T7[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` #### Update article by SKU — `PATCH /article/{sku}` - Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### Get Stückliste (bundle items) for an article — `GET /article/{sku}/articlelist` - Params: `sku: str` - Returns: `200 { items: { id: int, articleId: int, sku: str, name: str, count: int, sort: int }[] }` @@ -110,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 { article: T2 }` +- Returns: `204 void` #### Replace article categories by SKU — `PUT /article/{sku}/categories` - Params: `sku: str, body: { categoryIds: int[] }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### List child articles of a parent article — `GET /article/{sku}/children` - Params: `sku: str` - Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Create and attach a new child article to a parent article — `POST /article/{sku}/children` - Params: `sku: str, body: { attributeValueId?: int, value?: str, name?: str }` -- Returns: `201 { article: T33 }` +- Returns: `201 { sku: str }` #### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children` - Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }` -- Returns: `200 { article: T33, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}` - Params: `sku: str, childSku: str, query: deleteArticle?: bool` - Returns: `200 { success: bool, deleted: bool }` #### Replace article EANs by SKU — `PUT /article/{sku}/eans` - Params: `sku: str, body: { eans: str[] }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### 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 }` @@ -149,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 { article: T33 }` +- Returns: `204 void` #### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices` - Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### Print article label — `POST /article/{sku}/print` - Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }` - Returns: `200 { success: bool }` @@ -167,10 +162,10 @@ _none_ - Returns: `200 { ok: bool }` #### List article suppliers — `GET /article/{sku}/supplier` - Params: `sku: str` -- Returns: `200 { suppliers: T8[] }` +- Returns: `200 { suppliers: T7[] }` #### 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: T8 }` +- Returns: `201 { supplier: T7 }` #### Reorder article suppliers — `PUT /article/{sku}/supplier/order` - Params: `sku: str, body: { ids: int[] }` - Returns: `200 { ids: int[] }` @@ -179,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: T8 }` +- Returns: `200 { supplier: T7 }` #### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock` - Params: `sku: str, body: { track_stock: bool }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### Set article weight by SKU — `PUT /article/{sku}/weight` - Params: `sku: str, body: { weight: num }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` ### Section: /attributename #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T16[] }` +- Returns: `200 { attributenames: T15[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T16 }` +- Returns: `201 { attributename: T15 }` #### 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: T29[] }` +- Returns: `200 { values: T26[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T29 }` +- Returns: `201 { attributevalue: T26 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -212,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: T16 }` +- Returns: `200 { attributename: T15 }` ### Section: /attributevalue @@ -221,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: T29 }` +- Returns: `200 { attributevalue: T26 }` #### 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: T37[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T32[] } }` #### 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: T37[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T32[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T35 }` +- Returns: `200 { message: str, user: T31 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T35, googleClientId: str }` +- Returns: `200 { user: T31, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T35 }` +- Returns: `200 { user: T31 }` ### 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?: T6|null, latestDaily?: T6|null, latestMonthly?: T6|null }, backups: { counts: { hourly: int, daily: int, monthly: int }, hourly: T6[], daily: T6[], monthly: T6[] } }` +- 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?: T5|null, latestDaily?: T5|null, latestMonthly?: T5|null }, backups: { counts: { hourly: int, daily: int, monthly: int }, hourly: T5[], daily: T5[], monthly: T5[] } }` #### 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 }[] }` @@ -263,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: T37[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T32[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -272,19 +267,19 @@ _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: T37[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T32[] } }` #### 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: T37[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T32[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T32[] }` +- Returns: `200 { carriers: T29[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T32 }` +- Returns: `201 { carrier: T29 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -293,10 +288,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T32 }` +- Returns: `200 { carrier: T29 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T32 }` +- Returns: `200 { carrier: T29 }` ### Section: /category @@ -320,7 +315,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, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T26|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` +- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T24|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` #### List category attribute values — `GET /category/{id}/attributevalue` - Params: `id: int` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` @@ -347,10 +342,10 @@ _none_ #### List companies — `GET /company` _none_ -- Returns: `200 { companies: T18[] }` +- Returns: `200 { companies: T17[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T18, user: T35 }` +- Returns: `201 { company: T17, user: T31 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -380,7 +375,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: T18 }` +- Returns: `200 { company: T17 }` ### Section: /customergroup @@ -404,19 +399,19 @@ _none_ #### List deliveries — `GET /delivery` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int` -- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T40 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T35 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: T23[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `201 { delivery: T5 }` +- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: T22[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Returns: `201 { delivery: T4 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` - Returns: `204 void` #### Get delivery — `GET /delivery/{id}` - Params: `id: int` -- Returns: `200 { delivery: T5 }` +- Returns: `200 { delivery: T4 }` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T23[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `200 { delivery: T5 }` +- 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: T4 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -425,52 +420,52 @@ _none_ - Returns: `200 str` #### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf` - Params: `id: int` -- Returns: `201 { attachment: T10, fileUrl: str }` +- Returns: `201 { attachment: T9, fileUrl: str }` ### Section: /entity #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T25[] }` +- Returns: `200 { entities: T23[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T25 }` +- Returns: `201 { entity: T23 }` #### 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: T13[] }` +- Returns: `200 { addresses: T12[] }` #### 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: T13 }` +- Returns: `201 { address: T12 }` #### 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: T13 }` +- Returns: `200 { address: T12 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T38[] }` +- Returns: `200 { contacts: T33[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T38 }` +- Returns: `201 { contact: T33 }` #### 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: T38 }` +- Returns: `200 { contact: T33 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T25 }` +- Returns: `200 { entity: T23 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T25 }` +- Returns: `200 { entity: T23 }` ### Section: /events @@ -515,35 +510,35 @@ _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: { objects: T21[] } }` -- Returns: `201 { labeltemplate: T9 }` +- 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 { labeltemplate: T9 }` +- 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?: { objects: T21[] } }` -- Returns: `200 { labeltemplate: T9 }` +- 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?: { objects: T21[] } }` -- Returns: `200 { labeltemplate: T9 }` +- 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 { ledger: T15[] }` +- Returns: `200 { ledger: T14[] }` #### Query company-wide ledger history — `GET /ledger/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 { ledger: T15[] }` +- Returns: `200 { ledger: T14[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 { ledger: T15[] }` +- Returns: `200 { ledger: T14[] }` ### Section: /mcp @@ -573,16 +568,16 @@ _none_ #### List conversations — `GET /modelconversation` _none_ -- Returns: `200 { conversations: T17[] }` +- Returns: `200 { conversations: T16[] }` #### Create conversation — `POST /modelconversation` - Params: `body: { provider: str, model: str }` -- Returns: `201 { conversation: T17 }` +- Returns: `201 { conversation: T16 }` #### Delete conversation — `DELETE /modelconversation/{id}` - Params: `id: int` - Returns: `204 void` #### Get conversation — `GET /modelconversation/{id}` - Params: `id: int` -- Returns: `200 { conversation: T17 }` +- Returns: `200 { conversation: T16 }` #### 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 }[] }` @@ -623,7 +618,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, entityId: int, lines: T23[], externalNumber?: str|null }` +- Params: `body: { number: str, date: str, entityId: int, lines: T22[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -632,7 +627,7 @@ _none_ - Params: `id: int` - Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T23[] }` +- 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` @@ -642,25 +637,25 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T31[] }` +- Returns: `200 { payments: T28[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T31 }` +- Returns: `201 { payment: T28 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` -- Returns: `201 { attachment: T10, fileUrl: str }` +- Returns: `201 { attachment: T9, fileUrl: str }` #### List shipments of an order — `GET /order/{id}/shipment` - Params: `id: int` -- Returns: `200 { shipments: T3[] }` +- Returns: `200 { shipments: T2[] }` #### Create shipment for an order — `POST /order/{id}/shipment` - Params: `id: int, body: { lines: { sku: str, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[], date?: str, warehouseId?: int, externalNumber?: str }` -- Returns: `201 { shipment: T3 }` +- Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T19[] }` +- Returns: `200 { shippings: T18[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T19 }` +- Returns: `201 { shipping: T18 }` ### Section: /package @@ -678,16 +673,16 @@ _none_ #### List POS terminals — `GET /posterminal` _none_ -- Returns: `200 { posterminals: T11[] }` +- Returns: `200 { posterminals: T10[] }` #### Create POS terminal — `PUT /posterminal` - Params: `body: { name: str, rootCategoryId?: int|null, syncRootArticles?: bool }` -- Returns: `200 { posterminal: T11 }` +- 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: T11 }` +- Returns: `200 { posterminal: T10 }` #### Disable all categories on terminal — `DELETE /posterminal/{id}/all` - Params: `id: int` - Returns: `200 { id: int, categoryIds: int[] }` @@ -705,10 +700,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T22[] }` +- 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 { printer: T22 }` +- Returns: `201 { printer: T21 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -717,22 +712,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T22 }` +- 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 { printer: T22 }` +- 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 { printer: T22 }` +- Returns: `200 { printer: T21 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T30[] }` +- Returns: `200 { propertynames: T27[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T30 }` +- Returns: `201 { propertyname: T27 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -741,7 +736,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: T30 }` +- Returns: `200 { propertyname: T27 }` ### Section: /public @@ -753,7 +748,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: T28|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: T24[], 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: T25|null, brand: T24|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: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], 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 }[] }` @@ -762,19 +757,19 @@ _none_ #### List quotes — `GET /quote` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` -- Returns: `200 { quotes: T4[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T23[], entityId?: int|null, externalNumber?: str|null }` -- Returns: `201 { quote: T4 }` +- Params: `body: { number: str, date: str, lines: T22[], entityId?: int|null, externalNumber?: str|null }` +- Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` - Returns: `204 void` #### Get quote — `GET /quote/{id}` - Params: `id: int` -- Returns: `200 { quote: T4 }` +- Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T23[] }` -- Returns: `200 { quote: T4 }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T22[] }` +- Returns: `200 { quote: T3 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -782,11 +777,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?: T23[] }` +- 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 { attachment: T10, fileUrl: str }` +- Returns: `201 { attachment: T9, fileUrl: str }` ### Section: /serper @@ -813,10 +808,10 @@ _none_ - Returns: `204 void` #### Get shipment by ID — `GET /shipment/{id}` - Params: `id: int` -- Returns: `200 { shipment: T3 }` +- Returns: `200 { shipment: T2 }` #### Update shipment state or metadata — `PATCH /shipment/{id}` - Params: `id: int, body: { state?: str }` -- Returns: `200 { shipment: T3 }` +- Returns: `200 { shipment: T2 }` #### Delete shipment file attachment — `DELETE /shipment/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` @@ -825,13 +820,13 @@ _none_ - Returns: `200 str` #### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf` - Params: `id: int` -- Returns: `201 { attachment: T10, fileUrl: str }` +- Returns: `201 { attachment: T9, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T19[] }` +- Returns: `200 { shippings: T18[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T19 }` +- Returns: `201 { shipping: T18 }` ### Section: /shipping @@ -840,7 +835,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` -- Returns: `200 { shipping: T19 }` +- Returns: `200 { shipping: T18 }` #### 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 }[] }` @@ -861,7 +856,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: T15[] }` +- 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: T14[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` @@ -870,40 +865,40 @@ _none_ #### List subagent schedules — `GET /subagentschedule` _none_ -- Returns: `200 { schedules: T14[] }` +- Returns: `200 { schedules: T13[] }` #### Create subagent schedule — `POST /subagentschedule` - Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }` -- Returns: `201 { schedule: T14 }` +- Returns: `201 { schedule: T13 }` #### Delete subagent schedule — `DELETE /subagentschedule/{id}` - Params: `id: int` - Returns: `204 void` #### Get subagent schedule by ID — `GET /subagentschedule/{id}` - Params: `id: int` -- Returns: `200 { schedule: T14 }` +- Returns: `200 { schedule: T13 }` #### Update subagent schedule — `PUT /subagentschedule/{id}` - Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }` -- Returns: `200 { schedule: T14 }` +- Returns: `200 { schedule: T13 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T39[] }` +- Returns: `200 { suppliers: T34[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T39 }` +- Returns: `201 { supplier: T34 }` #### 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: T39 }` +- Returns: `200 { supplier: T34 }` #### 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?: T42|null, incoming?: { date: str, amount: num }[] }[] }` +- 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?: T37|null, incoming?: { date: str, amount: num }[] }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T42|null, incoming?: { date: str, amount: num }[] }[] }` +- 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?: T37|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /thumb @@ -918,10 +913,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T28[] }` +- Returns: `200 { units: T25[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T28 }` +- Returns: `200 { unit: T25 }` ### Section: /v1 diff --git a/docs/api/routes.md b/docs/api/routes.md index a5b21b7..2ee398d 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -9,39 +9,33 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T14[], externalNumber?: str|null, createdAt?: str, shipping?: T13|null, shippings?: T13[], payment?: T25|null, payments?: T25[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T3[], files?: T8[] }` -- `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: T22, brand: T20|null, categoryIds: int[], photos: T18[], eans: str[], prices: T28[], suppliers: T6[], undeliveredOrders: T21[] }` -- `T3` = `{ id: int, number: str, type: str, date: str, lines: T14[], shippings: T13[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T8[], state?: str }` -- `T4` = `{ id: int, number: str, type: str, date: str, lines: T14[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T8[] }` -- `T5` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T14[], files: T8[], externalNumber?: str|null, createdAt?: str, ledger?: T32 }` -- `T6` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T33|null, incoming?: { date: str, amount: num }[] }` -- `T7` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T15[] }, thumb?: str|null }` -- `T8` = `{ 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 }` -- `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: T23[], articleCount?: int }` -- `T13` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T14` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T15` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T16` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T17` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T18` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T19` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T20` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T21` = `{ orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }` -- `T22` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T23` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T24` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T25` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T26` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` -- `T27` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T28` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T29` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T30` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T31` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T32` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T33` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, shipping?: T12|null, shippings?: T12[], payment?: T21|null, payments?: T21[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T2[], files?: T7[] }` +- `T2` = `{ id: int, number: str, type: str, date: str, lines: T13[], shippings: T12[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }` +- `T3` = `{ id: int, number: str, type: str, date: str, lines: T13[], entityId?: int|null, externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` +- `T4` = `{ id: int, number: str, type: str, supplierId: int, date: str, lines: T13[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T26 }` +- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T27|null, incoming?: { date: str, amount: num }[] }` +- `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, 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 }` +- `T9` = `{ 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 }` +- `T10` = `{ 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 }` +- `T11` = `{ id: int, name: str, sort: int, exclusive: bool, values: T19[], articleCount?: int }` +- `T12` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `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` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T18` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T19` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T20` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T21` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T22` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T23` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T24` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T25` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T26` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T27` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -50,7 +44,7 @@ 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 { article: T27 }` +- Returns: `201 { sku: str }` #### Query company-wide article history — `GET /article/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { history: { id: int, date: str, sku: str, historytext: str, name?: str|null }[], total: int, unfilteredTotal: int, offset: int, limit: int }` @@ -59,10 +53,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` -- Returns: `200 { article: T2 }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T18, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` #### Update article by SKU — `PATCH /article/{sku}` - Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### Get Stückliste (bundle items) for an article — `GET /article/{sku}/articlelist` - Params: `sku: str` - Returns: `200 { items: { id: int, articleId: int, sku: str, name: str, count: int, sort: int }[] }` @@ -77,25 +71,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 { article: T2 }` +- Returns: `204 void` #### Replace article categories by SKU — `PUT /article/{sku}/categories` - Params: `sku: str, body: { categoryIds: int[] }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### List child articles of a parent article — `GET /article/{sku}/children` - Params: `sku: str` - Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Create and attach a new child article to a parent article — `POST /article/{sku}/children` - Params: `sku: str, body: { attributeValueId?: int, value?: str, name?: str }` -- Returns: `201 { article: T27 }` +- Returns: `201 { sku: str }` #### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children` - Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }` -- Returns: `200 { article: T27, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` #### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}` - Params: `sku: str, childSku: str, query: deleteArticle?: bool` - Returns: `200 { success: bool, deleted: bool }` #### Replace article EANs by SKU — `PUT /article/{sku}/eans` - Params: `sku: str, body: { eans: str[] }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### 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 }` @@ -113,10 +107,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 { article: T27 }` +- Returns: `204 void` #### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices` - Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### Print article label — `POST /article/{sku}/print` - Params: `sku: str, body: { templateId: int, printerId: int, quantity: int }` - Returns: `200 { success: bool }` @@ -131,10 +125,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: T6[] }` +- Returns: `200 { suppliers: T5[] }` #### Assign supplier to article — `POST /article/{sku}/supplier` - Params: `sku: str, body: { entityId: int, sku?: str|null, pu?: num, stock?: num|null, sort?: int|null, netPrice?: num|null, taxId?: int|null, taxRate?: num|null }` -- Returns: `201 { supplier: T6 }` +- Returns: `201 { supplier: T5 }` #### Reorder article suppliers — `PUT /article/{sku}/supplier/order` - Params: `sku: str, body: { ids: int[] }` - Returns: `200 { ids: int[] }` @@ -143,31 +137,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: T6 }` +- Returns: `200 { supplier: T5 }` #### Set article track_stock flag by SKU — `PUT /article/{sku}/track_stock` - Params: `sku: str, body: { track_stock: bool }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` #### Set article weight by SKU — `PUT /article/{sku}/weight` - Params: `sku: str, body: { weight: num }` -- Returns: `200 { article: T2 }` +- Returns: `204 void` ### Section: /attributename #### List attribute names — `GET /attributename` _none_ -- Returns: `200 { attributenames: T12[] }` +- Returns: `200 { attributenames: T11[] }` #### Create attribute name — `POST /attributename` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { attributename: T12 }` +- Returns: `201 { attributename: T11 }` #### Reorder attribute names — `PUT /attributename/order` - Params: `body: { attributenameIds: int[] }` - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T23[] }` +- Returns: `200 { values: T19[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T23 }` +- Returns: `201 { attributevalue: T19 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -176,7 +170,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: T12 }` +- Returns: `200 { attributename: T11 }` ### Section: /attributevalue @@ -185,10 +179,10 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T23 }` +- Returns: `200 { attributevalue: T19 }` #### 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: T29[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T23[] } }` ### Section: /brand @@ -197,7 +191,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: T29[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T23[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -206,16 +200,16 @@ _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: T29[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T23[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T26[] }` +- Returns: `200 { carriers: T22[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T26 }` +- Returns: `201 { carrier: T22 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -224,10 +218,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T26 }` +- Returns: `200 { carrier: T22 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T26 }` +- Returns: `200 { carrier: T22 }` ### Section: /category @@ -248,7 +242,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, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: T20|null, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` +- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null, brand?: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, articlewarehousesummary?: { id: int, articleId: int, warehouseId: int, stock: num, article_id?: int, warehouse_id?: int, warehouseName?: str|null }[], warehouses?: { id: int, name: str, stock: num }[] }[] }` #### List category attribute values — `GET /category/{id}/attributevalue` - Params: `id: int` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` @@ -317,70 +311,70 @@ _none_ #### List deliveries — `GET /delivery` - Params: `query: offset?: int, limit?: int, search?: str, onlyUnbooked?: bool, supplierId?: int, seekMonths?: int` -- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T32 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T26 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: T17[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `201 { delivery: T5 }` +- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: T16[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Returns: `201 { delivery: T4 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` - Returns: `204 void` #### Get delivery — `GET /delivery/{id}` - Params: `id: int` -- Returns: `200 { delivery: T5 }` +- Returns: `200 { delivery: T4 }` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T17[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` -- Returns: `200 { delivery: T5 }` +- 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: T4 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Generate and attach delivery note PDF (goods receipt) — `POST /delivery/{id}/pdf` - Params: `id: int` -- Returns: `201 { attachment: T8, fileUrl: str }` +- Returns: `201 { attachment: T7, fileUrl: str }` ### Section: /entity #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T19[] }` +- Returns: `200 { entities: T17[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T19 }` +- Returns: `201 { entity: T17 }` #### 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: T9[] }` +- Returns: `200 { addresses: T8[] }` #### 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: T9 }` +- Returns: `201 { address: T8 }` #### 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: T9 }` +- Returns: `200 { address: T8 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T30[] }` +- Returns: `200 { contacts: T24[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T30 }` +- Returns: `201 { contact: T24 }` #### 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: T30 }` +- Returns: `200 { contact: T24 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T19 }` +- Returns: `200 { entity: T17 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T19 }` +- Returns: `200 { entity: T17 }` ### Section: /health @@ -394,35 +388,35 @@ _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: { objects: T15[] } }` -- Returns: `201 { labeltemplate: T7 }` +- 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 { labeltemplate: T7 }` +- Returns: `200 { labeltemplate: T6 }` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T15[] } }` -- Returns: `200 { labeltemplate: T7 }` +- 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?: { objects: T15[] } }` -- Returns: `200 { labeltemplate: T7 }` +- 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 { ledger: T11[] }` +- Returns: `200 { ledger: T10[] }` #### Query company-wide ledger history — `GET /ledger/history` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { ledger: { id: int, date: str, transaction_type: str, transaction_text: str, sku?: str|null, name?: str|null, amount?: num }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Query ledger by manifest article ID — `GET /ledger/manifestarticle/{manifestarticleId}` - Params: `manifestarticleId: int, query: transaction_type?: str` -- Returns: `200 { ledger: T11[] }` +- Returns: `200 { ledger: T10[] }` #### Query ledger by article SKU — `GET /ledger/sku/{sku}` - Params: `sku: str, query: transaction_type?: str` -- Returns: `200 { ledger: T11[] }` +- Returns: `200 { ledger: T10[] }` ### Section: /number @@ -439,7 +433,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T1[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, entityId: int, lines: T17[], externalNumber?: str|null }` +- Params: `body: { number: str, date: str, entityId: int, lines: T16[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -448,32 +442,32 @@ _none_ - Params: `id: int` - Returns: `200 { order: T1 }` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T17[] }` +- 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: T25[] }` +- Returns: `200 { payments: T21[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T25 }` +- Returns: `201 { payment: T21 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` -- Returns: `201 { attachment: T8, fileUrl: str }` +- Returns: `201 { attachment: T7, fileUrl: str }` #### List shipments of an order — `GET /order/{id}/shipment` - Params: `id: int` -- Returns: `200 { shipments: T3[] }` +- Returns: `200 { shipments: T2[] }` #### Create shipment for an order — `POST /order/{id}/shipment` - Params: `id: int, body: { lines: { sku: str, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[], date?: str, warehouseId?: int, externalNumber?: str }` -- Returns: `201 { shipment: T3 }` +- Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T13[] }` +- Returns: `200 { shippings: T12[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T13 }` +- Returns: `201 { shipping: T12 }` ### Section: /package @@ -491,10 +485,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T16[] }` +- 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 { printer: T16 }` +- Returns: `201 { printer: T15 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -503,22 +497,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T16 }` +- 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 { printer: T16 }` +- 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 { printer: T16 }` +- Returns: `200 { printer: T15 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T24[] }` +- Returns: `200 { propertynames: T20[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T24 }` +- Returns: `201 { propertyname: T20 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -527,34 +521,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: T24 }` +- Returns: `200 { propertyname: T20 }` ### Section: /quote #### List quotes — `GET /quote` - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` -- Returns: `200 { quotes: T4[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T17[], entityId?: int|null, externalNumber?: str|null }` -- Returns: `201 { quote: T4 }` +- Params: `body: { number: str, date: str, lines: T16[], entityId?: int|null, externalNumber?: str|null }` +- Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` - Returns: `204 void` #### Get quote — `GET /quote/{id}` - Params: `id: int` -- Returns: `200 { quote: T4 }` +- Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T17[] }` -- Returns: `200 { quote: T4 }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T16[] }` +- Returns: `200 { quote: T3 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Create order from quote — `POST /quote/{id}/order` -- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T17[] }` +- 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 { attachment: T8, fileUrl: str }` +- Returns: `201 { attachment: T7, fileUrl: str }` ### Section: /shipment @@ -566,22 +560,22 @@ _none_ - Returns: `204 void` #### Get shipment by ID — `GET /shipment/{id}` - Params: `id: int` -- Returns: `200 { shipment: T3 }` +- Returns: `200 { shipment: T2 }` #### Update shipment state or metadata — `PATCH /shipment/{id}` - Params: `id: int, body: { state?: str }` -- Returns: `200 { shipment: T3 }` +- Returns: `200 { shipment: T2 }` #### Delete shipment file attachment — `DELETE /shipment/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Generate and attach shipment PDF (delivery note) — `POST /shipment/{id}/pdf` - Params: `id: int` -- Returns: `201 { attachment: T8, fileUrl: str }` +- Returns: `201 { attachment: T7, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T13[] }` +- Returns: `200 { shippings: T12[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` -- Returns: `201 { shipping: T13 }` +- Returns: `201 { shipping: T12 }` ### Section: /shipping @@ -590,7 +584,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` -- Returns: `200 { shipping: T13 }` +- Returns: `200 { shipping: T12 }` #### 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 }[] }` @@ -611,7 +605,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: T11[] }` +- 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: T10[] }` #### Ship shipment manifest item(s) — `POST /stock/ship` - Params: `body: { manifestarticleId?: int, warehouseId?: int, items?: { manifestarticleId: int, warehouseId?: int }[] }` - Returns: `200` @@ -620,40 +614,40 @@ _none_ #### List subagent schedules — `GET /subagentschedule` _none_ -- Returns: `200 { schedules: T10[] }` +- Returns: `200 { schedules: T9[] }` #### Create subagent schedule — `POST /subagentschedule` - Params: `body: { prompt: str, cron: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int }` -- Returns: `201 { schedule: T10 }` +- Returns: `201 { schedule: T9 }` #### Delete subagent schedule — `DELETE /subagentschedule/{id}` - Params: `id: int` - Returns: `204 void` #### Get subagent schedule by ID — `GET /subagentschedule/{id}` - Params: `id: int` -- Returns: `200 { schedule: T10 }` +- Returns: `200 { schedule: T9 }` #### Update subagent schedule — `PUT /subagentschedule/{id}` - Params: `id: int, body: { prompt?: str, cron?: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, max_itr?: int, lastrun_at?: str|null }` -- Returns: `200 { schedule: T10 }` +- Returns: `200 { schedule: T9 }` ### Section: /supplier #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T31[] }` +- Returns: `200 { suppliers: T25[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T31 }` +- Returns: `201 { supplier: T25 }` #### 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: T31 }` +- Returns: `200 { supplier: T25 }` #### 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?: T33|null, incoming?: { date: str, amount: num }[] }[] }` +- 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?: T27|null, incoming?: { date: str, amount: num }[] }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T33|null, incoming?: { date: str, amount: num }[] }[] }` +- 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?: T27|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /unit @@ -662,10 +656,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T22[] }` +- Returns: `200 { units: T18[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T22 }` +- Returns: `200 { unit: T18 }` ### Section: /warehouse diff --git a/docs/api/routes/article/_sku/children.post.md b/docs/api/routes/article/_sku/children.post.md index a5bda19..da8f798 100644 --- a/docs/api/routes/article/_sku/children.post.md +++ b/docs/api/routes/article/_sku/children.post.md @@ -34,13 +34,7 @@ Created child article ```json { - "article": { - "id": 1, - "categoryId": 1, - "name": "…", - "sku": "…", - "track_stock": true - } + "sku": "…" } ``` diff --git a/docs/api/routes/article/_sku/children.put.md b/docs/api/routes/article/_sku/children.put.md index eb8d71c..ddf4bfb 100644 --- a/docs/api/routes/article/_sku/children.put.md +++ b/docs/api/routes/article/_sku/children.put.md @@ -32,17 +32,10 @@ Attaches an existing article to this parent article. Idempotent if already a chi ## Response `200` -Attached child article and list of children +List of children after attaching ```json { - "article": { - "id": 1, - "categoryId": 1, - "name": "…", - "sku": "…", - "track_stock": true - }, "children": [ { "id": 1, diff --git a/docs/api/routes/article/_sku/parent.md b/docs/api/routes/article/_sku/parent.md index 71f7bdb..6e24409 100644 --- a/docs/api/routes/article/_sku/parent.md +++ b/docs/api/routes/article/_sku/parent.md @@ -34,21 +34,11 @@ when `isParent` is `false`. } ``` -## Response `200` +## Response `204` -Updated article +Updated -```json -{ - "article": { - "id": 1, - "categoryId": 1, - "name": "…", - "sku": "…", - "track_stock": true - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/_sku/track_stock.md b/docs/api/routes/article/_sku/track_stock.md index 4a462c8..bfd5204 100644 --- a/docs/api/routes/article/_sku/track_stock.md +++ b/docs/api/routes/article/_sku/track_stock.md @@ -29,99 +29,11 @@ Enables or disables inventory stock tracking for this article. On success, emits SSE signal: `article-` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/create.md b/docs/api/routes/article/create.md index c9e4cb4..f8e720a 100644 --- a/docs/api/routes/article/create.md +++ b/docs/api/routes/article/create.md @@ -33,13 +33,7 @@ Created ```json { - "article": { - "id": 1, - "categoryId": 1, - "name": "…", - "sku": "…", - "track_stock": true - } + "sku": "…" } ``` diff --git a/docs/api/routes/article/set-brand.md b/docs/api/routes/article/set-brand.md index 0a9fcaf..2da450f 100644 --- a/docs/api/routes/article/set-brand.md +++ b/docs/api/routes/article/set-brand.md @@ -30,99 +30,11 @@ Pass `null` to clear the brand. Returns the same shape as GET by SKU. On success, emits SSE signal: `article-` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/set-categories.md b/docs/api/routes/article/set-categories.md index 2872c96..42ab447 100644 --- a/docs/api/routes/article/set-categories.md +++ b/docs/api/routes/article/set-categories.md @@ -34,99 +34,11 @@ at least one category (empty array is rejected). Returns the same shape as GET b On success, emits SSE signal: `article-` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/set-eans.md b/docs/api/routes/article/set-eans.md index d0c6473..1f1c708 100644 --- a/docs/api/routes/article/set-eans.md +++ b/docs/api/routes/article/set-eans.md @@ -32,99 +32,11 @@ empty array clears all EANs. Returns the same shape as GET by SKU. On success, emits SSE signal: `article-` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/set-prices.md b/docs/api/routes/article/set-prices.md index d9efe74..e660920 100644 --- a/docs/api/routes/article/set-prices.md +++ b/docs/api/routes/article/set-prices.md @@ -50,99 +50,11 @@ Empty `prices` clears all POS prices. Returns the same shape as GET by SKU. On success, emits SSE signal: `article-` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/set-weight.md b/docs/api/routes/article/set-weight.md index d32191d..eb6cc6c 100644 --- a/docs/api/routes/article/set-weight.md +++ b/docs/api/routes/article/set-weight.md @@ -30,99 +30,11 @@ Returns the same shape as GET by SKU. On success, emits SSE signal: `article-` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/docs/api/routes/article/update.md b/docs/api/routes/article/update.md index 4fc79df..414ff18 100644 --- a/docs/api/routes/article/update.md +++ b/docs/api/routes/article/update.md @@ -36,99 +36,11 @@ Patches article fields. At least one of `name`, `unitamount`, `unitSi` required. On success, emits SSE signal: `articles` (see [`GET /events`](../events.md)). -## Response `200` +## Response `204` -Updated article detail +Updated -```json -{ - "article": { - "id": 1, - "sku": "…", - "name": "…", - "slug": "…", - "desc": "…", - "seo": "…", - "track_stock": true, - "unitamount": 1, - "weight": 1, - "unit": { - "si": "…", - "basesi": "…", - "basesifactor": 1, - "symbol": "…", - "name": "…" - }, - "brand": { - "id": 1, - "name": "…", - "fullHash": "…", - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - }, - "categoryIds": [ - 1 - ], - "photos": [ - { - "sort": 1, - "fullHash": "…", - "fullW": 1, - "fullH": 1, - "fullSize": 1, - "thumbW": 1, - "thumbH": 1, - "thumbHash": "…" - } - ], - "eans": [ - "…" - ], - "prices": [ - { - "minmultiplier": 1, - "net": 1, - "taxRate": 1, - "customergroupId": 1 - } - ], - "suppliers": [ - { - "id": 1, - "articleId": 1, - "entityId": 1, - "supplierName": "…", - "sku": "…", - "pu": 1, - "stock": 1, - "sort": 1, - "priceId": 1, - "price": { - "net": 1, - "taxId": 1, - "taxRate": 1 - }, - "incoming": [ - { - "date": "2026-08-10T00:00:00.000Z", - "amount": 1 - } - ] - } - ], - "undeliveredOrders": [ - { - "orderId": 1, - "orderNumber": "…", - "date": "2026-08-10T00:00:00.000Z", - "customerName": "…", - "amount": 1 - } - ] - } -} -``` +_No content_ ## Errors diff --git a/src/api/routes/article/attributes.js b/src/api/routes/article/attributes.js index 15fdb23..e90adf7 100644 --- a/src/api/routes/article/attributes.js +++ b/src/api/routes/article/attributes.js @@ -74,15 +74,8 @@ export function register(app, basePath = '') { * taxRate: 19 * minmultiplier: 10 * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Invalid prices, POS customer group required, or parent article cannot have prices * content: @@ -121,9 +114,9 @@ export function register(app, basePath = '') { } try { - const article = await db.setPricesBySku(req.user.id, skuParsed.sku, req.body.prices); + await db.setPricesBySku(req.user.id, skuParsed.sku, req.body.prices); emitArticleSignal(req, skuParsed.sku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Set article prices failed:', error); @@ -167,15 +160,8 @@ export function register(app, basePath = '') { * example: * eans: ["4001234567890"] * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Invalid eans * content: @@ -220,9 +206,9 @@ export function register(app, basePath = '') { } try { - const article = await db.setEansBySku(req.user.id, skuParsed.sku, req.body.eans); + await db.setEansBySku(req.user.id, skuParsed.sku, req.body.eans); emitArticleSignal(req, skuParsed.sku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Set article eans failed:', error); @@ -266,15 +252,8 @@ export function register(app, basePath = '') { * example: * brandId: 3 * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Validation error * content: @@ -314,9 +293,9 @@ export function register(app, basePath = '') { } try { - const article = await db.setBrandIdBySku(req.user.id, skuParsed.sku, brandId); + await db.setBrandIdBySku(req.user.id, skuParsed.sku, brandId); emitArticleSignal(req, skuParsed.sku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Set article brand failed:', error); @@ -358,15 +337,8 @@ export function register(app, basePath = '') { * example: * weight: 1.5 * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Invalid weight * content: @@ -403,9 +375,9 @@ export function register(app, basePath = '') { const weight = req.body?.weight; try { - const article = await db.setWeightBySku(req.user.id, skuParsed.sku, weight); + await db.setWeightBySku(req.user.id, skuParsed.sku, weight); emitArticleSignal(req, skuParsed.sku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Set article weight failed:', error); @@ -449,15 +421,8 @@ export function register(app, basePath = '') { * example: * track_stock: true * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Invalid track_stock * content: @@ -497,9 +462,9 @@ export function register(app, basePath = '') { } try { - const article = await db.setTrackStockBySku(req.user.id, skuParsed.sku, Boolean(raw)); + await db.setTrackStockBySku(req.user.id, skuParsed.sku, Boolean(raw)); emitArticleSignal(req, skuParsed.sku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Set article track_stock failed:', error); @@ -548,15 +513,8 @@ export function register(app, basePath = '') { * example: * categoryIds: [4, 7] * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Invalid categoryIds or empty array * content: @@ -595,13 +553,13 @@ export function register(app, basePath = '') { } try { - const article = await db.setCategoryIdsBySku( + await db.setCategoryIdsBySku( req.user.id, skuParsed.sku, req.body.categoryIds, ); emitArticleSignal(req, skuParsed.sku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Set article categories failed:', error); diff --git a/src/api/routes/article/crud.js b/src/api/routes/article/crud.js index 91b18ab..f06ab97 100644 --- a/src/api/routes/article/crud.js +++ b/src/api/routes/article/crud.js @@ -64,8 +64,8 @@ export function register(app, basePath = '') { * schema: * type: object * properties: - * article: - * $ref: '#/components/schemas/ArticleSummary' + * sku: + * type: string * 400: * description: Validation error * content: @@ -133,11 +133,7 @@ export function register(app, basePath = '') { seo: req.body?.seo !== undefined ? req.body.seo : undefined, }); emitArticlesSignal(req); - const article = { - ...created, - categoryId: created.parentId, - }; - res.status(201).json({ article }); + res.status(201).json({ sku: created.sku }); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Create article failed:', error); @@ -501,15 +497,8 @@ export function register(app, basePath = '') { * unitamount: 0.24 * unitSi: l * responses: - * 200: - * description: Updated article detail - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/ArticleDetail' + * 204: + * description: Updated * 400: * description: Validation error (Name required / Invalid unitamount) * content: @@ -753,10 +742,10 @@ export function register(app, basePath = '') { try { const decodedSku = decodeURIComponent(sku); - const article = await db.updateBySku(req.user.id, decodedSku, patch); + await db.updateBySku(req.user.id, decodedSku, patch); emitArticlesSignal(req); emitArticleSignal(req, decodedSku); - res.status(200).json({ article }); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Update article by sku failed:', error); diff --git a/src/api/routes/article/variants.js b/src/api/routes/article/variants.js index ca00305..2dbb5de 100644 --- a/src/api/routes/article/variants.js +++ b/src/api/routes/article/variants.js @@ -56,15 +56,8 @@ export function register(app, basePath = '') { * The attributename id used for the article's variants. Omitting it while * enabling parent mode returns 400. Must be omitted when `isParent` is `false`. * responses: - * 200: - * description: Updated article - * content: - * application/json: - * schema: - * type: object - * properties: - * article: - * $ref: '#/components/schemas/Article' + * 204: + * description: Updated * 400: * description: | * Invalid input — `attributeNameId` missing while `isParent` is true, article still @@ -89,13 +82,13 @@ export function register(app, basePath = '') { const attributeNameId = req.body?.attributeNameId; try { - const result = await db.toggleParent(req.user.id, parsed.sku, { + await db.toggleParent(req.user.id, parsed.sku, { isParent, attributeNameId, }); emitArticleSignal(req, parsed.sku); emitArticlesSignal(req); - res.status(200).json(result); + res.status(204).end(); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Toggle parent failed:', error); @@ -196,8 +189,8 @@ export function register(app, basePath = '') { * schema: * type: object * properties: - * article: - * $ref: '#/components/schemas/Article' + * sku: + * type: string * 400: * description: Parent not configured as parent, missing value, duplicate variant, or sku was provided in body * put: @@ -237,14 +230,12 @@ export function register(app, basePath = '') { * description: Whether to allow re-parenting if child already belongs to another parent * responses: * 200: - * description: Attached child article and list of children + * description: List of children after attaching * content: * application/json: * schema: * type: object * properties: - * article: - * $ref: '#/components/schemas/Article' * children: * type: array * items: @@ -275,7 +266,7 @@ export function register(app, basePath = '') { emitArticleSignal(req, result.article.sku); } emitArticlesSignal(req); - res.status(201).json(result); + res.status(201).json({ sku: result.article.sku }); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Add child failed:', error); @@ -303,7 +294,7 @@ export function register(app, basePath = '') { emitArticleSignal(req, parsed.sku); emitArticleSignal(req, childSku); emitArticlesSignal(req); - res.status(200).json(result); + res.status(200).json({ children: result.children }); } catch (error) { const status = articleErrorStatus(error); if (status === 500) console.error('Attach child failed:', error);