From e4e4d2dcf0a17368c4e8f00074f80f1439e4350f Mon Sep 17 00:00:00 2001 From: seb Date: Wed, 21 Oct 2026 03:31:55 +0200 Subject: [PATCH] u --- docs/api/routes-all.md | 177 ++++++++++---------- docs/api/routes.md | 151 ++++++++--------- docs/api/routes/order/_id/shipment.get.md | 3 +- docs/api/routes/order/_id/shipment.post.md | 9 +- docs/api/routes/order/create.md | 8 +- docs/api/routes/order/get.md | 6 +- docs/api/routes/order/list.md | 6 +- docs/api/routes/order/update.md | 6 +- docs/api/routes/quote/create.md | 3 +- docs/api/routes/quote/get.md | 3 +- docs/api/routes/quote/list.md | 3 +- docs/api/routes/quote/order.md | 9 +- docs/api/routes/quote/update.md | 3 +- docs/api/routes/shipment/_id.get.md | 3 +- docs/api/routes/shipment/_id.patch.md | 3 +- src/api/openapi.js | 8 +- src/api/routes/order.js | 2 +- src/api/routes/shipment.js | 9 +- src/db/order.js | 1 + src/services/companyExport.js | 2 + src/services/companyImport/orderImporter.js | 21 ++- 21 files changed, 243 insertions(+), 193 deletions(-) diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index 0776f1e..07ce708 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -9,43 +9,44 @@ 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: 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 }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T18[], externalNumber?: str|null, createdAt?: str, shipping?: T20|null, shippings?: T20[], payment?: T29|null, payments?: T29[], 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: T18[], shippings: T20[], 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: T18[], 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: T21[], files: T9[], externalNumber?: str|null, createdAt?: str, ledger?: T36 }` - `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 }` +- `T7` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T38|null, incoming?: { date: str, amount: num }[] }` +- `T8` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T22[] }, 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 }` +- `T11` = `{ vfs: T37, storage: T37, database: T31 }` - `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 }` +- `T15` = `{ id: int, name: str, sort: int, exclusive: bool, values: T27[], 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 }` +- `T18` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` +- `T19` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` +- `T20` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T21` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T22` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T23` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T24` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T25` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T26` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T27` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T28` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T29` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T30` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T31` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T32` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T33` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T34` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T35` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T36` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T37` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T38` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -87,7 +88,7 @@ _none_ - Returns: `204 void` #### Get article by SKU — `GET /article/{sku}` - Params: `sku: str` -- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: 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 }[] } }` +- 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: T26, brand: T25|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: `204 void` @@ -195,10 +196,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T26[] }` +- Returns: `200 { values: T27[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T26 }` +- Returns: `201 { attributevalue: T27 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -216,28 +217,28 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T26 }` +- Returns: `200 { attributevalue: T27 }` #### 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: T32[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T33[] } }` #### 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: T32[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T33[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T31 }` +- Returns: `200 { message: str, user: T32 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T31, googleClientId: str }` +- Returns: `200 { user: T32, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T31 }` +- Returns: `200 { user: T32 }` ### Section: /backup @@ -258,7 +259,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: T32[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T33[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -267,19 +268,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: T32[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T33[] } }` #### 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: T32[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T33[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T29[] }` +- Returns: `200 { carriers: T30[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T29 }` +- Returns: `201 { carrier: T30 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -288,10 +289,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T29 }` +- Returns: `200 { carrier: T30 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T29 }` +- Returns: `200 { carrier: T30 }` ### Section: /category @@ -315,7 +316,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?: 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 }[] }[] }` +- 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?: T25|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 }[] }` @@ -345,7 +346,7 @@ _none_ - Returns: `200 { companies: T17[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T17, user: T31 }` +- Returns: `201 { company: T17, user: T32 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -399,9 +400,9 @@ _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?: T35 }[], 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?: T36 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- 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 } }[] }` +- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T4 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -410,7 +411,7 @@ _none_ - Params: `id: int` - Returns: `200 { delivery: T4 }` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T22[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 { delivery: T4 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -426,10 +427,10 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T23[] }` +- Returns: `200 { entities: T24[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T23 }` +- Returns: `201 { entity: T24 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` @@ -447,25 +448,25 @@ _none_ - Returns: `200 { address: T12 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T33[] }` +- Returns: `200 { contacts: T34[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T33 }` +- Returns: `201 { contact: T34 }` #### 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: T33 }` +- Returns: `200 { contact: T34 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T23 }` +- Returns: `200 { entity: T24 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T23 }` +- Returns: `200 { entity: T24 }` ### Section: /events @@ -510,7 +511,7 @@ _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: T20[] } }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T22[] } }` - Returns: `201 { labeltemplate: T8 }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -519,10 +520,10 @@ _none_ - Params: `id: int` - 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: T20[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T22[] } }` - 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: T20[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T22[] } }` - Returns: `200 { labeltemplate: T8 }` ### Section: /ledger @@ -618,7 +619,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: T22[], externalNumber?: str|null }` +- Params: `body: { number: str, date: str, entityId: int, lines: T19[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -627,7 +628,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?: T22[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T19[] }` - Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -637,10 +638,10 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T28[] }` +- Returns: `200 { payments: T29[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T28 }` +- Returns: `201 { payment: T29 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T9, fileUrl: str }` @@ -648,14 +649,14 @@ _none_ - Params: `id: int` - 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 }` +- Params: `id: int, body: { lines: { sku?: str, orderLineId?: int, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[], date?: str, warehouseId?: int, externalNumber?: str }` - Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T18[] }` +- Returns: `200 { shippings: T20[] }` #### 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: T18 }` +- Returns: `201 { shipping: T20 }` ### Section: /package @@ -700,10 +701,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T21[] }` +- Returns: `200 { printers: T23[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 { printer: T21 }` +- Returns: `201 { printer: T23 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -712,22 +713,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T21 }` +- Returns: `200 { printer: T23 }` #### 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: T21 }` +- Returns: `200 { printer: T23 }` #### 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: T21 }` +- Returns: `200 { printer: T23 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T27[] }` +- Returns: `200 { propertynames: T28[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T27 }` +- Returns: `201 { propertyname: T28 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -736,7 +737,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: T27 }` +- Returns: `200 { propertyname: T28 }` ### Section: /public @@ -748,7 +749,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: 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 }[] } }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T26|null, brand: T25|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 }[] }` @@ -759,7 +760,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T22[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T19[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -768,7 +769,7 @@ _none_ - Params: `id: int` - Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T22[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T19[] }` - Returns: `200 { quote: T3 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -777,7 +778,7 @@ _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?: T22[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T19[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -823,10 +824,10 @@ _none_ - Returns: `201 { attachment: T9, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T18[] }` +- Returns: `200 { shippings: T20[] }` #### 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: T18 }` +- Returns: `201 { shipping: T20 }` ### Section: /shipping @@ -835,7 +836,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: T18 }` +- Returns: `200 { shipping: T20 }` #### 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 }[] }` @@ -883,22 +884,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T34[] }` +- Returns: `200 { suppliers: T35[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T34 }` +- Returns: `201 { supplier: T35 }` #### 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: T34 }` +- Returns: `200 { supplier: T35 }` #### 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?: T37|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?: T38|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?: T37|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?: T38|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /thumb @@ -913,10 +914,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T25[] }` +- Returns: `200 { units: T26[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T25 }` +- Returns: `200 { unit: T26 }` ### Section: /v1 diff --git a/docs/api/routes.md b/docs/api/routes.md index 2ee398d..21c483c 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -9,33 +9,34 @@ 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: 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 }` +- `T1` = `{ id: int, number: str, type: str, entityId: int, date: str, lines: T12[], externalNumber?: str|null, createdAt?: str, shipping?: T14|null, shippings?: T14[], payment?: T22|null, payments?: T22[], 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: T12[], shippings: T14[], 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: T12[], 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: T15[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T27 }` +- `T5` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T28|null, incoming?: { date: str, amount: num }[] }` +- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T16[] }, 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 }` +- `T11` = `{ id: int, name: str, sort: int, exclusive: bool, values: T20[], articleCount?: int }` +- `T12` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null, shippable: bool }` +- `T13` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null, shippable?: bool }` +- `T14` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T15` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T16` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T17` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T18` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T19` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T20` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T21` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T22` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T23` = `{ id: int, name: str, sort: int, hasPackages: bool, isReverse: bool }` +- `T24` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T25` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T26` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T27` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T28` = `{ net: num, taxId: int, taxRate?: num|null }` ### Routes @@ -53,7 +54,7 @@ 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: { 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 }[] } }` +- 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: T19, brand: { name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }, categoryIds: int[], photos: { sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }[], eans: str[], prices: { minmultiplier: num, net: num, taxRate: num, customergroupId: int }[], suppliers: T5[], undeliveredOrders: { orderId: int, orderNumber: str, date: str, amount: num, customerName?: str|null }[] } }` #### Update article by SKU — `PATCH /article/{sku}` - Params: `sku: str, body: { name?: str, desc?: str, seo?: str, unitamount?: num, unitSi?: str, track_stock?: bool }` - Returns: `204 void` @@ -158,10 +159,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T19[] }` +- Returns: `200 { values: T20[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T19 }` +- Returns: `201 { attributevalue: T20 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -179,10 +180,10 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T19 }` +- Returns: `200 { attributevalue: T20 }` #### 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: T23[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T24[] } }` ### Section: /brand @@ -191,7 +192,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: T23[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T24[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -200,16 +201,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: T23[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T24[] } }` ### Section: /carrier #### List carriers — `GET /carrier` _none_ -- Returns: `200 { carriers: T22[] }` +- Returns: `200 { carriers: T23[] }` #### Create carrier — `POST /carrier` - Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `201 { carrier: T22 }` +- Returns: `201 { carrier: T23 }` #### Reorder carriers — `PUT /carrier/order` - Params: `body: { carrierIds: int[] }` - Returns: `200 { carrierIds: int[] }` @@ -218,10 +219,10 @@ _none_ - Returns: `204 void` #### Get carrier by ID — `GET /carrier/{id}` - Params: `id: int` -- Returns: `200 { carrier: T22 }` +- Returns: `200 { carrier: T23 }` #### Update carrier — `PATCH /carrier/{id}` - Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` -- Returns: `200 { carrier: T22 }` +- Returns: `200 { carrier: T23 }` ### Section: /category @@ -311,9 +312,9 @@ _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?: T26 }[], 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?: T27 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- 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 } }[] }` +- Params: `body: { externalNumber: str, date: str, supplierId: int, lines: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T4 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -322,7 +323,7 @@ _none_ - Params: `id: int` - Returns: `200 { delivery: T4 }` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T16[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: { amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 { delivery: T4 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -335,10 +336,10 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T17[] }` +- Returns: `200 { entities: T18[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T17 }` +- Returns: `201 { entity: T18 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` @@ -356,25 +357,25 @@ _none_ - Returns: `200 { address: T8 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T24[] }` +- Returns: `200 { contacts: T25[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T24 }` +- Returns: `201 { contact: T25 }` #### 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: T24 }` +- Returns: `200 { contact: T25 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T17 }` +- Returns: `200 { entity: T18 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T17 }` +- Returns: `200 { entity: T18 }` ### Section: /health @@ -388,7 +389,7 @@ _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: T14[] } }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: { objects: T16[] } }` - Returns: `201 { labeltemplate: T6 }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -397,10 +398,10 @@ _none_ - Params: `id: int` - Returns: `200 { labeltemplate: T6 }` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T14[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T16[] } }` - 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: T14[] } }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: { objects: T16[] } }` - Returns: `200 { labeltemplate: T6 }` ### Section: /ledger @@ -433,7 +434,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: T16[], externalNumber?: str|null }` +- Params: `body: { number: str, date: str, entityId: int, lines: T13[], externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -442,17 +443,17 @@ _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?: T16[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T13[] }` - 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: T21[] }` +- Returns: `200 { payments: T22[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T21 }` +- Returns: `201 { payment: T22 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 { attachment: T7, fileUrl: str }` @@ -460,14 +461,14 @@ _none_ - Params: `id: int` - 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 }` +- Params: `id: int, body: { lines: { sku?: str, orderLineId?: int, amount?: num, name?: str, pu?: num, net?: num, rebate?: num, taxrate?: num, comment?: str }[], date?: str, warehouseId?: int, externalNumber?: str }` - Returns: `201 { shipment: T2 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T12[] }` +- Returns: `200 { shippings: T14[] }` #### 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: T12 }` +- Returns: `201 { shipping: T14 }` ### Section: /package @@ -485,10 +486,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T15[] }` +- Returns: `200 { printers: T17[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 { printer: T15 }` +- Returns: `201 { printer: T17 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -497,22 +498,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T15 }` +- Returns: `200 { printer: T17 }` #### 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: T15 }` +- Returns: `200 { printer: T17 }` #### 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: T15 }` +- Returns: `200 { printer: T17 }` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T20[] }` +- Returns: `200 { propertynames: T21[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T20 }` +- Returns: `201 { propertyname: T21 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -521,7 +522,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: T20 }` +- Returns: `200 { propertyname: T21 }` ### Section: /quote @@ -529,7 +530,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T3[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T16[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T13[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T3 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -538,13 +539,13 @@ _none_ - Params: `id: int` - Returns: `200 { quote: T3 }` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T16[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T13[] }` - 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?: T16[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T13[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -572,10 +573,10 @@ _none_ - Returns: `201 { attachment: T7, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T12[] }` +- Returns: `200 { shippings: T14[] }` #### 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: T12 }` +- Returns: `201 { shipping: T14 }` ### Section: /shipping @@ -584,7 +585,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: T12 }` +- Returns: `200 { shipping: T14 }` #### 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 }[] }` @@ -632,22 +633,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T25[] }` +- Returns: `200 { suppliers: T26[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T25 }` +- Returns: `201 { supplier: T26 }` #### 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: T25 }` +- Returns: `200 { supplier: T26 }` #### 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?: T27|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?: T28|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?: T27|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?: T28|null, incoming?: { date: str, amount: num }[] }[] }` ### Section: /unit @@ -656,10 +657,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T18[] }` +- Returns: `200 { units: T19[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T18 }` +- Returns: `200 { unit: T19 }` ### Section: /warehouse diff --git a/docs/api/routes/order/_id/shipment.get.md b/docs/api/routes/order/_id/shipment.get.md index 10b3049..cc12de3 100644 --- a/docs/api/routes/order/_id/shipment.get.md +++ b/docs/api/routes/order/_id/shipment.get.md @@ -39,7 +39,8 @@ List of shipments "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/order/_id/shipment.post.md b/docs/api/routes/order/_id/shipment.post.md index 74a25d7..46e2c28 100644 --- a/docs/api/routes/order/_id/shipment.post.md +++ b/docs/api/routes/order/_id/shipment.post.md @@ -27,7 +27,8 @@ Updates the materialized `ordersummary` table (`shipped_quantity`, `is_shipped`) | `warehouseId` | no | integer | Optional target warehouse ID to deduct stock from (defaults to company default warehouse) | | `externalNumber` | no | string | Optional external delivery note reference (defaults to order.externalNumber or order.number) | | `lines` | yes | object[] | Positions to ship | -| `lines[].sku` | yes | string | Article SKU | +| `lines[].sku` | no | string | Article SKU (omit for SKU-less order lines) | +| `lines[].orderLineId` | no | integer | Order line id (`lines[].id` of the order); required for SKU-less lines, ignored when `sku` is given | | `lines[].amount` | no | number | Quantity to ship. Defaults to remaining unshipped quantity for this SKU. | | `lines[].name` | no | string | | | `lines[].pu` | no | number | | @@ -44,6 +45,7 @@ Updates the materialized `ordersummary` table (`shipped_quantity`, `is_shipped`) "lines": [ { "sku": "…", + "orderLineId": 1, "amount": 1, "name": "…", "pu": 1, @@ -82,7 +84,8 @@ Created shipment "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ @@ -124,7 +127,7 @@ Created shipment | Status | Description | |--------|-------------| -| 400 | Validation error or article not in order — `{"error":"…"}` | +| 400 | Validation error, article not in order, or article not shippable — `{"error":"…"}` | | 401 | Unauthorized — `{"error":"…"}` | | 404 | Order not found — `{"error":"…"}` | | 409 | Cumulative shipment amount exceeds ordered amount, or insufficient stock — `{"error":"…"}` | diff --git a/docs/api/routes/order/create.md b/docs/api/routes/order/create.md index 7b0676c..d5c1cf9 100644 --- a/docs/api/routes/order/create.md +++ b/docs/api/routes/order/create.md @@ -7,7 +7,7 @@ Create order Creates a sales order with header and lines in one transaction. `date` is the document date (expected delivery). `entityId` must be a company customer (not Lieferanten). -Each line requires `sku` or `name`, `amount`, `net`, and `taxrate` (rate); `pu` defaults to `1`; `rebate` defaults to `0`. +Each line requires `sku` or `name`, `amount`, `net`, and `taxrate` (rate); `pu` defaults to `1`; `rebate` defaults to `0`; `shippable` defaults to `true` (`false` = not shippable, excluded from order completeness). ## Body (JSON) @@ -62,7 +62,8 @@ Created order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shipping": { @@ -131,7 +132,8 @@ Created order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/order/get.md b/docs/api/routes/order/get.md index 1199285..0e83715 100644 --- a/docs/api/routes/order/get.md +++ b/docs/api/routes/order/get.md @@ -36,7 +36,8 @@ Order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shipping": { @@ -105,7 +106,8 @@ Order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/order/list.md b/docs/api/routes/order/list.md index 644da1d..ef1d037 100644 --- a/docs/api/routes/order/list.md +++ b/docs/api/routes/order/list.md @@ -45,7 +45,8 @@ Order list "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shipping": { @@ -114,7 +115,8 @@ Order list "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/order/update.md b/docs/api/routes/order/update.md index baedc9e..053a3f0 100644 --- a/docs/api/routes/order/update.md +++ b/docs/api/routes/order/update.md @@ -56,7 +56,8 @@ Updated order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shipping": { @@ -125,7 +126,8 @@ Updated order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/quote/create.md b/docs/api/routes/quote/create.md index c1e2867..a7718c4 100644 --- a/docs/api/routes/quote/create.md +++ b/docs/api/routes/quote/create.md @@ -66,7 +66,8 @@ Created quote "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "files": [ diff --git a/docs/api/routes/quote/get.md b/docs/api/routes/quote/get.md index 9803185..b9ec620 100644 --- a/docs/api/routes/quote/get.md +++ b/docs/api/routes/quote/get.md @@ -40,7 +40,8 @@ Quote "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "files": [ diff --git a/docs/api/routes/quote/list.md b/docs/api/routes/quote/list.md index f9e1056..b9b9427 100644 --- a/docs/api/routes/quote/list.md +++ b/docs/api/routes/quote/list.md @@ -46,7 +46,8 @@ Quote list "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "files": [ diff --git a/docs/api/routes/quote/order.md b/docs/api/routes/quote/order.md index b5ab548..77985e2 100644 --- a/docs/api/routes/quote/order.md +++ b/docs/api/routes/quote/order.md @@ -44,7 +44,8 @@ Fails with 400 (No entity selected) if neither the quote nor the request body sp "net": 1, "taxrate": 1, "rebate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ] } @@ -74,7 +75,8 @@ Created order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shipping": { @@ -143,7 +145,8 @@ Created order "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/quote/update.md b/docs/api/routes/quote/update.md index 514222b..654e0a5 100644 --- a/docs/api/routes/quote/update.md +++ b/docs/api/routes/quote/update.md @@ -60,7 +60,8 @@ Updated quote "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "files": [ diff --git a/docs/api/routes/shipment/_id.get.md b/docs/api/routes/shipment/_id.get.md index 9eab5d0..0f572db 100644 --- a/docs/api/routes/shipment/_id.get.md +++ b/docs/api/routes/shipment/_id.get.md @@ -38,7 +38,8 @@ Shipment details "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/docs/api/routes/shipment/_id.patch.md b/docs/api/routes/shipment/_id.patch.md index 2bc4dd9..2d9d063 100644 --- a/docs/api/routes/shipment/_id.patch.md +++ b/docs/api/routes/shipment/_id.patch.md @@ -56,7 +56,8 @@ Updated shipment "net": 1, "rebate": 1, "taxrate": 1, - "comment": "…" + "comment": "…", + "shippable": true } ], "shippings": [ diff --git a/src/api/openapi.js b/src/api/openapi.js index d8059aa..91cda59 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -974,7 +974,7 @@ * type: string * ManifestLine: * type: object - * required: [id, sku, name, pu, amount, net, rebate, taxrate, comment] + * required: [id, sku, name, pu, amount, net, rebate, taxrate, shippable, comment] * description: Line shape for quote and order * properties: * id: @@ -1001,6 +1001,9 @@ * comment: * type: string * nullable: true + * shippable: + * type: boolean + * description: false for non-shippable lines (e.g. shipping cost, rounding); excluded from shipment and from order completeness (`isShipped`) * ManifestLineInput: * type: object * required: [amount, net, taxrate] @@ -1030,6 +1033,9 @@ * comment: * type: string * nullable: true + * shippable: + * type: boolean + * description: Defaults to true. Set false for non-shippable lines (e.g. shipping cost, rounding); they cannot be shipped and do not make the order incomplete. * QuoteSummary: * type: object * required: [id, number, type, date] diff --git a/src/api/routes/order.js b/src/api/routes/order.js index e411cf7..e5ebca6 100644 --- a/src/api/routes/order.js +++ b/src/api/routes/order.js @@ -151,7 +151,7 @@ export function register(app, basePath = '') { * Creates a sales order with header and lines in one transaction. * `date` is the document date (expected delivery). * `entityId` must be a company customer (not Lieferanten). - * Each line requires `sku` or `name`, `amount`, `net`, and `taxrate` (rate); `pu` defaults to `1`; `rebate` defaults to `0`. + * Each line requires `sku` or `name`, `amount`, `net`, and `taxrate` (rate); `pu` defaults to `1`; `rebate` defaults to `0`; `shippable` defaults to `true` (`false` = not shippable, excluded from order completeness). * security: * - cookieAuth: [] * x-markdown: order/create.md diff --git a/src/api/routes/shipment.js b/src/api/routes/shipment.js index de50ab7..eee1292 100644 --- a/src/api/routes/shipment.js +++ b/src/api/routes/shipment.js @@ -181,11 +181,14 @@ export function register(app, basePath = '') { * description: Positions to ship * items: * type: object - * required: [sku] + * description: Provide `sku` for order lines with a SKU, or `orderLineId` for SKU-less order lines (exactly one of them). * properties: * sku: * type: string - * description: Article SKU + * description: Article SKU (omit for SKU-less order lines) + * orderLineId: + * type: integer + * description: Order line id (`lines[].id` of the order); required for SKU-less lines, ignored when `sku` is given * amount: * type: number * description: Quantity to ship. Defaults to remaining unshipped quantity for this SKU. @@ -212,7 +215,7 @@ export function register(app, basePath = '') { * shipment: * $ref: '#/components/schemas/Shipment' * 400: - * description: Validation error or article not in order + * description: Validation error, article not in order, or article not shippable * content: * application/json: * schema: diff --git a/src/db/order.js b/src/db/order.js index 9d2b603..f8957b3 100644 --- a/src/db/order.js +++ b/src/db/order.js @@ -30,6 +30,7 @@ function calculatePaidTotal(payments = []) { function calculateOrderedQuantity(lines = []) { let qty = 0; for (const line of lines) { + if (line.shippable === false) continue; qty += Number(line.amount || 0); } return Math.round(qty * 1000) / 1000; diff --git a/src/services/companyExport.js b/src/services/companyExport.js index e1a36fa..872dd99 100644 --- a/src/services/companyExport.js +++ b/src/services/companyExport.js @@ -538,6 +538,7 @@ export async function executeCompanyExport({ '"net"', '"taxrate"', '"sort"', + '"shippable"', ]; const manifestCsvRows = [manifestCsvHeaders.join(';')]; @@ -588,6 +589,7 @@ export async function executeCompanyExport({ formatCsvField(formatGermanFloat(line.net ?? 0)), formatCsvField(formatGermanFloat(line.taxrate ?? 19)), formatCsvField(line.sort ?? 0), + formatCsvField(line.shippable !== false ? '1' : '0'), ].join(';')); } } diff --git a/src/services/companyImport/orderImporter.js b/src/services/companyImport/orderImporter.js index f1ea78e..b15350c 100644 --- a/src/services/companyImport/orderImporter.js +++ b/src/services/companyImport/orderImporter.js @@ -261,6 +261,14 @@ export async function importOrders({ const rebate = parseGermanFloat(it.rebate ?? it.fRabatt, 0); const comment = cleanValue(it.comment ?? it.cHinweis) || null; + let shippable = true; + if (it.shippable !== undefined && it.shippable !== null && String(it.shippable).trim() !== '') { + const s = String(it.shippable).trim().toLowerCase(); + shippable = s !== '0' && s !== 'false'; + } else if (/^(summe glätten|shippingcost|versandkosten)$/i.test(name.trim())) { + shippable = false; + } + return { sku, name, @@ -269,6 +277,7 @@ export async function importOrders({ taxrate, rebate, comment, + shippable, }; }); @@ -355,9 +364,15 @@ export async function importOrders({ const isShipped = String(m.shipped ?? '').trim() === '1'; if (isShipped || shippingType) { - const shippableLines = lines - .filter((l) => l.sku) - .map((l) => ({ sku: l.sku, amount: l.amount })); + const orderLines = createdOrder?.lines || lines; + const shippableLines = orderLines + .filter((l) => l.shippable !== false) + .map((l) => { + if (l.sku) return { sku: l.sku, amount: l.amount }; + if (l.id) return { orderLineId: l.id, amount: l.amount }; + return null; + }) + .filter(Boolean); if (shippableLines.length > 0) { try {