From de3e74c9281503e3099b3efc66eb5a9e237ef49c Mon Sep 17 00:00:00 2001 From: seb Date: Tue, 20 Oct 2026 02:23:00 +0200 Subject: [PATCH] u --- docs/api/routes-all.md | 117 ++++++++++---------- docs/api/routes.md | 95 ++++++++-------- docs/api/routes/article/_sku/track_stock.md | 9 ++ docs/api/routes/article/get.md | 9 ++ docs/api/routes/article/set-brand.md | 9 ++ docs/api/routes/article/set-categories.md | 9 ++ docs/api/routes/article/set-eans.md | 9 ++ docs/api/routes/article/set-prices.md | 9 ++ docs/api/routes/article/set-weight.md | 9 ++ docs/api/routes/article/update.md | 9 ++ src/api/openapi.js | 26 +++++ 11 files changed, 205 insertions(+), 105 deletions(-) diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index 6298d92..9e89b8f 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -9,22 +9,22 @@ 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?: T30|null, payments?: T30[], 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: T27, brand: T26|null, categoryIds: int[], photos: T24[], eans: str[], prices: T35[], suppliers: T8[] }` +- `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?: T39 }` +- `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?: T41|null, incoming?: { date: str, amount: num }[] }` +- `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: T40, storage: T40, database: T33 }` +- `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: T28[], articleCount?: int }` +- `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 }` @@ -35,21 +35,22 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - `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` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T28` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T29` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T30` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T31` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` -- `T32` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T33` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T34` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T35` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T36` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T37` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T38` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T39` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T40` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T41` = `{ net: num, taxId: int, taxRate?: num|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 }` ### Routes @@ -79,7 +80,7 @@ _none_ #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 { article: T32 }` +- Returns: `201 { article: T33 }` #### Export articles as ZIP — `GET /article/export.zip` - Params: `query: categoryId?: int` - Returns: `200 zip` @@ -118,10 +119,10 @@ _none_ - 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: T32 }` +- Returns: `201 { article: T33 }` #### 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: T32, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T33, 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 }` @@ -148,7 +149,7 @@ _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: T32 }` +- Returns: `200 { article: T33 }` #### 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 }` @@ -199,10 +200,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T28[] }` +- Returns: `200 { values: T29[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T28 }` +- Returns: `201 { attributevalue: T29 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -220,28 +221,28 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T28 }` +- Returns: `200 { attributevalue: T29 }` #### 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: T36[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T37[] } }` #### 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: T36[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T37[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T34 }` +- Returns: `200 { message: str, user: T35 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T34, googleClientId: str }` +- Returns: `200 { user: T35, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T34 }` +- Returns: `200 { user: T35 }` ### Section: /backup @@ -262,7 +263,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: T36[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T37[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -271,19 +272,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: T36[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T37[] } }` #### 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: T36[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T37[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T31[] }` +- Returns: `200 { carriers: T32[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T31 }` +- Returns: `201 { carrier: T32 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -292,10 +293,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T31 }` +- Returns: `200 { carrier: T32 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T31 }` +- Returns: `200 { carrier: T32 }` ### Section: /category @@ -349,7 +350,7 @@ _none_ - Returns: `200 { companies: T18[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T18, user: T34 }` +- Returns: `201 { company: T18, user: T35 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -403,7 +404,7 @@ _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?: T39 }[], 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?: T40 }[], 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 }` @@ -451,16 +452,16 @@ _none_ - Returns: `200 { address: T13 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T37[] }` +- Returns: `200 { contacts: T38[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T37 }` +- Returns: `201 { contact: T38 }` #### 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: T37 }` +- Returns: `200 { contact: T38 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` @@ -641,10 +642,10 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T30[] }` +- Returns: `200 { payments: T31[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T30 }` +- Returns: `201 { payment: T31 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T10, fileUrl: str }` @@ -728,10 +729,10 @@ _none_ #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T29[] }` +- Returns: `200 { propertynames: T30[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T29 }` +- Returns: `201 { propertyname: T30 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -740,7 +741,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: T29 }` +- Returns: `200 { propertyname: T30 }` ### Section: /public @@ -752,7 +753,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: T27|null, brand: T26|null, price: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }, prices: { minmultiplier: num, net: num|null, taxRate: num|null, gross: num|null }[], categories: { id: int, name: str, slug: str }[], photos: 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: 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 }[] } }` #### 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 }[] }` @@ -884,22 +885,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T38[] }` +- Returns: `200 { suppliers: T39[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T38 }` +- Returns: `201 { supplier: T39 }` #### 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: T38 }` +- Returns: `200 { supplier: T39 }` #### 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?: T41|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?: T42|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?: T41|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?: T42|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /thumb @@ -914,10 +915,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T27[] }` +- Returns: `200 { units: T28[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T27 }` +- Returns: `200 { unit: T28 }` ### Section: /v1 diff --git a/docs/api/routes.md b/docs/api/routes.md index ed80c6f..79fff12 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -9,18 +9,18 @@ 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?: T24|null, payments?: T24[], 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: T21, brand: T20|null, categoryIds: int[], photos: T18[], eans: str[], prices: T27[], suppliers: T6[] }` +- `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?: T31 }` -- `T6` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T32|null, incoming?: { date: str, amount: num }[] }` +- `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: T22[], articleCount?: int }` +- `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 }` @@ -29,18 +29,19 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - `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` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T22` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T24` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T25` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` -- `T26` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T27` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T28` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T29` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T30` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T31` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T32` = `{ net: num, taxId: int, taxRate?: num|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 }` ### Routes @@ -49,7 +50,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: T26 }` +- Returns: `201 { article: T27 }` #### 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 }` @@ -85,10 +86,10 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - 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: T26 }` +- Returns: `201 { article: T27 }` #### 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: T26, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T27, 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 }` @@ -112,7 +113,7 @@ 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: T26 }` +- Returns: `200 { article: T27 }` #### 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 }` @@ -163,10 +164,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T22[] }` +- Returns: `200 { values: T23[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T22 }` +- Returns: `201 { attributevalue: T23 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -184,10 +185,10 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T22 }` +- Returns: `200 { attributevalue: T23 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T28[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T29[] } }` ### Section: /brand @@ -196,7 +197,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: T28[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T29[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -205,16 +206,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: T28[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T29[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T25[] }` +- Returns: `200 { carriers: T26[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T25 }` +- Returns: `201 { carrier: T26 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -223,10 +224,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T25 }` +- Returns: `200 { carrier: T26 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T25 }` +- Returns: `200 { carrier: T26 }` ### Section: /category @@ -316,7 +317,7 @@ _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?: T31 }[], 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?: T32 }[], 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 }` @@ -361,16 +362,16 @@ _none_ - Returns: `200 { address: T9 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T29[] }` +- Returns: `200 { contacts: T30[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T29 }` +- Returns: `201 { contact: T30 }` #### 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: T29 }` +- Returns: `200 { contact: T30 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` @@ -454,10 +455,10 @@ _none_ - Returns: `204 void` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T24[] }` +- Returns: `200 { payments: T25[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T24 }` +- Returns: `201 { payment: T25 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T8, fileUrl: str }` @@ -514,10 +515,10 @@ _none_ #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T23[] }` +- Returns: `200 { propertynames: T24[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T23 }` +- Returns: `201 { propertyname: T24 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -526,7 +527,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: T23 }` +- Returns: `200 { propertyname: T24 }` ### Section: /quote @@ -634,22 +635,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T30[] }` +- Returns: `200 { suppliers: T31[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T30 }` +- Returns: `201 { supplier: T31 }` #### 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: T30 }` +- Returns: `200 { supplier: T31 }` #### 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?: T32|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?: T33|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?: T32|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?: T33|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /unit @@ -658,10 +659,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T21[] }` +- Returns: `200 { units: T22[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T21 }` +- Returns: `200 { unit: T22 }` ### Section: /warehouse diff --git a/docs/api/routes/article/_sku/track_stock.md b/docs/api/routes/article/_sku/track_stock.md index 4ec5da5..4a462c8 100644 --- a/docs/api/routes/article/_sku/track_stock.md +++ b/docs/api/routes/article/_sku/track_stock.md @@ -109,6 +109,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/get.md b/docs/api/routes/article/get.md index 2c5fe86..a997ef9 100644 --- a/docs/api/routes/article/get.md +++ b/docs/api/routes/article/get.md @@ -92,6 +92,15 @@ Article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/set-brand.md b/docs/api/routes/article/set-brand.md index d7bae9e..0a9fcaf 100644 --- a/docs/api/routes/article/set-brand.md +++ b/docs/api/routes/article/set-brand.md @@ -110,6 +110,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/set-categories.md b/docs/api/routes/article/set-categories.md index 8be3181..2872c96 100644 --- a/docs/api/routes/article/set-categories.md +++ b/docs/api/routes/article/set-categories.md @@ -114,6 +114,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/set-eans.md b/docs/api/routes/article/set-eans.md index 3aba5a8..d0c6473 100644 --- a/docs/api/routes/article/set-eans.md +++ b/docs/api/routes/article/set-eans.md @@ -112,6 +112,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/set-prices.md b/docs/api/routes/article/set-prices.md index ddfc239..d9efe74 100644 --- a/docs/api/routes/article/set-prices.md +++ b/docs/api/routes/article/set-prices.md @@ -130,6 +130,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/set-weight.md b/docs/api/routes/article/set-weight.md index 7d6ca6e..d32191d 100644 --- a/docs/api/routes/article/set-weight.md +++ b/docs/api/routes/article/set-weight.md @@ -110,6 +110,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/docs/api/routes/article/update.md b/docs/api/routes/article/update.md index 158e6eb..4fc79df 100644 --- a/docs/api/routes/article/update.md +++ b/docs/api/routes/article/update.md @@ -116,6 +116,15 @@ Updated article detail } ] } + ], + "undeliveredOrders": [ + { + "orderId": 1, + "orderNumber": "…", + "date": "2026-08-10T00:00:00.000Z", + "customerName": "…", + "amount": 1 + } ] } } diff --git a/src/api/openapi.js b/src/api/openapi.js index 52ae3a4..0bcfda3 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -188,6 +188,32 @@ * type: array * items: * $ref: '#/components/schemas/ArticleSupplier' + * undeliveredOrders: + * type: array + * description: Remaining unshipped order positions for this article across open orders + * items: + * $ref: '#/components/schemas/ArticleUndeliveredOrder' + * ArticleUndeliveredOrder: + * type: object + * required: [orderId, orderNumber, date, amount] + * properties: + * orderId: + * type: integer + * description: Order manifest ID + * orderNumber: + * type: string + * description: Order document number + * date: + * type: string + * format: date-time + * description: Order date + * customerName: + * type: string + * nullable: true + * description: Customer name + * amount: + * type: number + * description: Remaining undelivered quantity in this order * ArticlePhoto: * type: object * description: Article photo metadata