diff --git a/docs/api/README.md b/docs/api/README.md index c327c4d..4cac0f8 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -97,6 +97,12 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route | [`routes/brand/update.md`](routes/brand/update.md) | `PATCH /brand/{id}` | | [`routes/brand/_id/image.delete.md`](routes/brand/_id/image.delete.md) | `DELETE /brand/{id}/image` | | [`routes/brand/_id/image.post.md`](routes/brand/_id/image.post.md) | `POST /brand/{id}/image` | +| [`routes/carrier.get.md`](routes/carrier.get.md) | `GET /carrier` | +| [`routes/carrier.post.md`](routes/carrier.post.md) | `POST /carrier` | +| [`routes/carrier/order.md`](routes/carrier/order.md) | `PUT /carrier/order` | +| [`routes/carrier/_id.delete.md`](routes/carrier/_id.delete.md) | `DELETE /carrier/{id}` | +| [`routes/carrier/_id.get.md`](routes/carrier/_id.get.md) | `GET /carrier/{id}` | +| [`routes/carrier/_id.patch.md`](routes/carrier/_id.patch.md) | `PATCH /carrier/{id}` | | [`routes/category/create.md`](routes/category/create.md) | `POST /category` | | [`routes/category/export.zip.md`](routes/category/export.zip.md) | `GET /category/export.zip` | | [`routes/category/order.md`](routes/category/order.md) | `PUT /category/order` | @@ -300,6 +306,7 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A | `articles` | `POST /article`, `DELETE /article/{sku}`, `PATCH /article/{sku}`, `DELETE /category/{id}`, `POST /stock/accept`, `POST /stock/adjust`, `POST /stock/ship` | | `attributename` | `POST /attributename`, `PUT /attributename/order`, `DELETE /attributename/{id}`, `PATCH /attributename/{id}`, `DELETE /attributevalue/{id}/image`, `POST /attributevalue/{id}/image` | | `brand` | `POST /brand`, `DELETE /brand/{id}`, `PATCH /brand/{id}`, `DELETE /brand/{id}/image`, `POST /brand/{id}/image` | +| `carrier` | `POST /carrier`, `PUT /carrier/order`, `DELETE /carrier/{id}`, `PATCH /carrier/{id}` | | `category` | `POST /category`, `PUT /category/order`, `DELETE /category/{id}`, `PATCH /category/{id}`, `DELETE /category/{id}/image`, `POST /category/{id}/image` | | `delivery` | `DELETE /delivery/{id}/file/{fileId}`, `POST /delivery/{id}/pdf`, `POST /stock/accept` | | `labeltemplate` | `POST /labeltemplate`, `DELETE /labeltemplate/{id}`, `PATCH /labeltemplate/{id}`, `PUT /labeltemplate/{id}` | diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index e675b18..5b97ca9 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -1,6 +1,6 @@ # Dash API Routes Overview (All) -Overview of all 255 API endpoints across all modules. +Overview of all 261 API endpoints across all modules. ### Notation @@ -9,46 +9,47 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T19[], externalNumber?: str|null, createdAt?: str, shipping?: T25|null, shippings?: T25[], payment?: T30|null, payments?: T30[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T3[], files?: T9[] }` -- `T2` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T27, brand: T26|null, categoryIds: int[], photos: T23[], eans: str[], prices: T34[], suppliers: T11[] }` -- `T3` = `{ id: int, number: str, type: str, date: str, lines: T19[], shippings: T25[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T9[], state?: str }` -- `T4` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T19[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T9[] }` -- `T5` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T19[], files: T9[], externalNumber?: str|null, createdAt?: str, ledger?: T38 }` +- `T1` = `{ id: int, number: str, type: str, entityId: int|null, 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?: T9[] }` +- `T2` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T27, brand: T26|null, categoryIds: int[], photos: T24[], eans: str[], prices: T35[], suppliers: T11[] }` +- `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?: T9[], state?: str }` +- `T4` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T20[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T9[] }` +- `T5` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T20[], files: T9[], externalNumber?: str|null, createdAt?: str, ledger?: T39 }` - `T6` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T7|null }` - `T7` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T12, totalSizeBytes: int, durationMs: int }` -- `T8` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T20[] }, thumb?: str|null }` +- `T8` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T21[] }, thumb?: str|null }` - `T9` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` - `T10` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }` -- `T11` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null }` -- `T12` = `{ vfs: T39, storage: T39, database: T32 }` +- `T11` = `{ 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 }` +- `T12` = `{ vfs: T40, storage: T40, database: T33 }` - `T13` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` - `T14` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` - `T15` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` - `T16` = `{ id: int, name: str, sort: int, exclusive: bool, values: T28[], articleCount?: int }` - `T17` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: int|null, first_message?: str|null }` - `T18` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` -- `T19` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T20` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T21` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T22` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T23` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T24` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T25` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T19` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T20` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T21` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T22` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T23` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T24` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T25` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` - `T26` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` - `T27` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` - `T28` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` - `T29` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` - `T30` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T31` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T32` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T33` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T34` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T35` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T36` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T37` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T38` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T39` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T40` = `{ net: num, taxId: int, taxRate?: num|null }` +- `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 }` ### Routes @@ -78,7 +79,7 @@ _none_ #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 { article: T31 }` +- Returns: `201 { article: T32 }` #### Export articles as ZIP — `GET /article/export.zip` - Params: `query: categoryId?: int` - Returns: `200 zip` @@ -114,10 +115,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: T31 }` +- Returns: `201 { article: T32 }` #### 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: T31, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T32, 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 }` @@ -144,7 +145,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: T31 }` +- Returns: `200 { article: T32 }` #### 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 }` @@ -219,25 +220,25 @@ _none_ - Returns: `200 { attributevalue: T28 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T35[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T36[] } }` #### 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: T35[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T36[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T33 }` +- Returns: `200 { message: str, user: T34 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T33, googleClientId: str }` +- Returns: `200 { user: T34, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T33 }` +- Returns: `200 { user: T34 }` ### 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: T35[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T36[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -267,10 +268,31 @@ _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: T35[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T36[] } }` #### 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: T35[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T36[] } }` + +### Section: /carrier + +#### List carriers — `GET /carrier` +_none_ +- Returns: `200 { carriers: T31[] }` +#### Create carrier — `POST /carrier` +- Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` +- Returns: `201 { carrier: T31 }` +#### Reorder carriers — `PUT /carrier/order` +- Params: `body: { carrierIds: int[] }` +- Returns: `200 { carrierIds: int[] }` +#### Delete carrier — `DELETE /carrier/{id}` +- Params: `id: int` +- Returns: `204 void` +#### Get carrier by ID — `GET /carrier/{id}` +- Params: `id: int` +- Returns: `200 { carrier: T31 }` +#### Update carrier — `PATCH /carrier/{id}` +- Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` +- Returns: `200 { carrier: T31 }` ### Section: /category @@ -324,7 +346,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: T33 }` +- Returns: `201 { company: T18, user: T34 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -378,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|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T38 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T39 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T22[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `body: { externalNumber: str, date: str, lines: T23[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T5 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -389,7 +411,7 @@ _none_ - Params: `id: int` - Returns: `200 { delivery: T5 }` #### 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?: T23[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 { delivery: T5 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -405,10 +427,10 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T24[] }` +- Returns: `200 { entities: T25[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T24 }` +- Returns: `201 { entity: T25 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` @@ -426,25 +448,25 @@ _none_ - Returns: `200 { address: T13 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T36[] }` +- Returns: `200 { contacts: T37[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T36 }` +- Returns: `201 { contact: T37 }` #### 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: T36 }` +- Returns: `200 { contact: T37 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T24 }` +- Returns: `200 { entity: T25 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T24 }` +- Returns: `200 { entity: T25 }` ### Section: /events @@ -486,7 +508,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: T21[] } }` - Returns: `201 { labeltemplate: T8 }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -495,10 +517,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: T21[] } }` - 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: T21[] } }` - Returns: `200 { labeltemplate: T8 }` ### Section: /ledger @@ -591,7 +613,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, lines: T22[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T23[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -600,7 +622,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?: T23[] }` - Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -625,10 +647,10 @@ _none_ - Returns: `201 { shipment: T3 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T25[] }` +- Returns: `200 { shippings: T19[] }` #### Create shipping for an order — `POST /order/{id}/shipping` -- Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 { shipping: T25 }` +- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` +- Returns: `201 { shipping: T19 }` ### Section: /package @@ -673,10 +695,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T21[] }` +- Returns: `200 { printers: T22[] }` #### 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: T22 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -685,13 +707,13 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T21 }` +- Returns: `200 { printer: T22 }` #### 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: T22 }` #### 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: T22 }` ### Section: /propertyname @@ -721,7 +743,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: T23[], eans: str[], isParent: bool, parentSku: str|null, variants: { id: int, sku: str, sort: int, name: str, slug: str, attributeValueId: int|null, attributeValue: str|null, unitamount: num|null, weight: num|null, trackStock: bool }[] } }` +- 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 }[] } }` #### 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 }[] }` @@ -732,7 +754,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T4[], 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: T23[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T4 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -741,7 +763,7 @@ _none_ - Params: `id: int` - Returns: `200 { quote: T4 }` #### 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?: T23[] }` - Returns: `200 { quote: T4 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -750,7 +772,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?: T23[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -796,10 +818,10 @@ _none_ - Returns: `201 { attachment: T9, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T25[] }` +- Returns: `200 { shippings: T19[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` -- Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 { shipping: T25 }` +- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` +- Returns: `201 { shipping: T19 }` ### Section: /shipping @@ -807,8 +829,8 @@ _none_ - Params: `id: int` - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` -- Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 { shipping: T25 }` +- Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` +- Returns: `200 { shipping: T19 }` #### List packages of a shipping — `GET /shipping/{id}/package` - Params: `id: int` - Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }` @@ -856,22 +878,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T37[] }` +- Returns: `200 { suppliers: T38[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T37 }` +- Returns: `201 { supplier: T38 }` #### 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: T37 }` +- Returns: `200 { supplier: T38 }` #### 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?: T40|null }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T41|null }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T40|null }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T41|null }[] }` ### Section: /thumb diff --git a/docs/api/routes.md b/docs/api/routes.md index 7a1d0d2..51ab1f8 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -1,6 +1,6 @@ # Dash API Routes Overview -Overview of all 180 API endpoints across all modules. +Overview of all 186 API endpoints across all modules. ### Notation @@ -9,37 +9,38 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types -- `T1` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, shipping?: T19|null, shippings?: T19[], payment?: T24|null, payments?: T24[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T3[], files?: T7[] }` -- `T2` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T21, brand: T20|null, categoryIds: int[], photos: T17[], eans: str[], prices: T26[], suppliers: T8[] }` -- `T3` = `{ id: int, number: str, type: str, date: str, lines: T13[], shippings: T19[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T7[], state?: str }` -- `T4` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T13[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` -- `T5` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T13[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T30 }` -- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T14[] }, thumb?: str|null }` +- `T1` = `{ id: int, number: str, type: str, entityId: int|null, 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?: T7[] }` +- `T2` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T21, brand: T20|null, categoryIds: int[], photos: T18[], eans: str[], prices: T27[], suppliers: T8[] }` +- `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?: T7[], state?: str }` +- `T4` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T14[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T7[] }` +- `T5` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T14[], files: T7[], externalNumber?: str|null, createdAt?: str, ledger?: T31 }` +- `T6` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: { objects: T15[] }, thumb?: str|null }` - `T7` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` -- `T8` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null }` +- `T8` = `{ 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 }` - `T9` = `{ id: int, entityId: int, addressType: str, firstName?: str|null, name?: str|null, street?: str|null, streetNumber?: str|null, zip?: str|null, city?: str|null, county?: str|null }` - `T10` = `{ id: int, company_id: int, prompt: str, max_itr: int, cron: str, created_at: str, desc?: str|null, skills?: str|null, lastagentnote?: str|null, lastrun_at?: str|null }` - `T11` = `{ id: int, manifestarticle_id: int, transaction_type: str, amount: num, transaction_text: str, hash_version: int, prev_hash?: str, sku?: str|null, created_at?: str }` - `T12` = `{ id: int, name: str, sort: int, exclusive: bool, values: T22[], articleCount?: int }` -- `T13` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T14` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T15` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T16` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T17` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T18` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T19` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T13` = `{ id: int, manifestId: int, number: str, carrierId: int, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T14` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T15` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T16` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T17` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T18` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T19` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` - `T20` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` - `T21` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` - `T22` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` - `T23` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` - `T24` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T25` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T26` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T27` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T28` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T29` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T30` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T31` = `{ net: num, taxId: int, taxRate?: num|null }` +- `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 }` ### Routes @@ -48,7 +49,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: T25 }` +- Returns: `201 { article: T26 }` #### Delete article by SKU — `DELETE /article/{sku}` - Params: `sku: str, query: cascade?: bool` - Returns: `204 void` @@ -81,10 +82,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: T25 }` +- Returns: `201 { article: T26 }` #### 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: T25, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T26, 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 }` @@ -108,7 +109,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: T25 }` +- Returns: `200 { article: T26 }` #### 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 }` @@ -183,10 +184,10 @@ _none_ - Returns: `200 { attributevalue: T22 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T27[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T28[] } }` #### 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: T27[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T28[] } }` ### Section: /brand @@ -195,7 +196,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: T27[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T28[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -204,10 +205,31 @@ _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: T27[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T28[] } }` #### 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: T27[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T28[] } }` + +### Section: /carrier + +#### List carriers — `GET /carrier` +_none_ +- Returns: `200 { carriers: T25[] }` +#### Create carrier — `POST /carrier` +- Params: `body: { name: str, sort?: int, hasPackages?: bool, isReverse?: bool }` +- Returns: `201 { carrier: T25 }` +#### Reorder carriers — `PUT /carrier/order` +- Params: `body: { carrierIds: int[] }` +- Returns: `200 { carrierIds: int[] }` +#### Delete carrier — `DELETE /carrier/{id}` +- Params: `id: int` +- Returns: `204 void` +#### Get carrier by ID — `GET /carrier/{id}` +- Params: `id: int` +- Returns: `200 { carrier: T25 }` +#### Update carrier — `PATCH /carrier/{id}` +- Params: `id: int, body: { name?: str, sort?: int, hasPackages?: bool, isReverse?: bool }` +- Returns: `200 { carrier: T25 }` ### Section: /category @@ -297,9 +319,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|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T30 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T31 }[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T16[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `body: { externalNumber: str, date: str, lines: T17[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 { delivery: T5 }` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -308,7 +330,7 @@ _none_ - Params: `id: int` - Returns: `200 { delivery: T5 }` #### 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?: T17[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 { delivery: T5 }` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -321,10 +343,10 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T18[] }` +- Returns: `200 { entities: T19[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 { entity: T18 }` +- Returns: `201 { entity: T19 }` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` @@ -342,25 +364,25 @@ _none_ - Returns: `200 { address: T9 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T28[] }` +- Returns: `200 { contacts: T29[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T28 }` +- Returns: `201 { contact: T29 }` #### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity contact — `PATCH /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }` -- Returns: `200 { contact: T28 }` +- Returns: `200 { contact: T29 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 { entity: T18 }` +- Returns: `200 { entity: T19 }` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 { entity: T18 }` +- Returns: `200 { entity: T19 }` ### Section: /labeltemplate @@ -368,7 +390,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: T15[] } }` - Returns: `201 { labeltemplate: T6 }` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -377,10 +399,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: T15[] } }` - 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: T15[] } }` - Returns: `200 { labeltemplate: T6 }` ### Section: /ledger @@ -410,7 +432,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, lines: T16[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T17[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { order: T1 }` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -419,7 +441,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?: T16[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T17[] }` - Returns: `200 { order: T1 }` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -441,10 +463,10 @@ _none_ - Returns: `201 { shipment: T3 }` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T19[] }` +- Returns: `200 { shippings: T13[] }` #### Create shipping for an order — `POST /order/{id}/shipping` -- Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 { shipping: T19 }` +- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` +- Returns: `201 { shipping: T13 }` ### Section: /package @@ -462,10 +484,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T15[] }` +- Returns: `200 { printers: T16[] }` #### 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: T16 }` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -474,13 +496,13 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 { printer: T15 }` +- Returns: `200 { printer: T16 }` #### 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: T16 }` #### 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: T16 }` ### Section: /propertyname @@ -506,7 +528,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T4[], 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: T17[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 { quote: T4 }` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -515,13 +537,13 @@ _none_ - Params: `id: int` - Returns: `200 { quote: T4 }` #### 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?: T17[] }` - Returns: `200 { quote: T4 }` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Create order from quote — `POST /quote/{id}/order` -- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T16[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T17[] }` - Returns: `201 { order: T1 }` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -549,10 +571,10 @@ _none_ - Returns: `201 { attachment: T7, fileUrl: str }` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T19[] }` +- Returns: `200 { shippings: T13[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` -- Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 { shipping: T19 }` +- Params: `id: int, body: { carrierId: int, type: str, state: str, trackingCode?: str, warehouseId?: int }` +- Returns: `201 { shipping: T13 }` ### Section: /shipping @@ -560,8 +582,8 @@ _none_ - Params: `id: int` - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` -- Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 { shipping: T19 }` +- Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrierId?: int, warehouseId?: int }` +- Returns: `200 { shipping: T13 }` #### 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 }[] }` @@ -609,22 +631,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T29[] }` +- Returns: `200 { suppliers: T30[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T29 }` +- Returns: `201 { supplier: T30 }` #### Delete supplier — `DELETE /supplier/{id}` - Params: `id: int` - Returns: `204 void` #### Update supplier — `PATCH /supplier/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { supplier: T29 }` +- Returns: `200 { supplier: T30 }` #### List supplier articles by SKUs — `GET /supplier/{id}/articles` - Params: `id: int, query: skus?: str` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null }[] }` +- 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 }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T31|null }[] }` +- 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 }[] }` ### Section: /unit diff --git a/docs/api/routes/carrier.get.md b/docs/api/routes/carrier.get.md new file mode 100644 index 0000000..fde087e --- /dev/null +++ b/docs/api/routes/carrier.get.md @@ -0,0 +1,37 @@ +# `GET /carrier` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +List carriers + +Lists carriers for the selected company, ordered by sort and name. + +## Response `200` + +List of carriers + +```json +{ + "carriers": [ + { + "id": 1, + "name": "…", + "sort": 1, + "hasPackages": true, + "isReverse": true + } + ] +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | No company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/carrier.post.md b/docs/api/routes/carrier.post.md new file mode 100644 index 0000000..8de3135 --- /dev/null +++ b/docs/api/routes/carrier.post.md @@ -0,0 +1,60 @@ +# `POST /carrier` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Create carrier + +Creates a new carrier for the selected company. +Sort order will be automatically appended if omitted. + + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `name` | yes | string | | +| `sort` | no | integer | Optional sort order | +| `hasPackages` | no | boolean | | +| `isReverse` | no | boolean | | + +```json +{ + "name": "…", + "sort": 1, + "hasPackages": true, + "isReverse": true +} +``` + +## Signals + +On success, emits SSE signal: `carrier` (see [`GET /events`](../events.md)). + +## Response `201` + +Created carrier + +```json +{ + "carrier": { + "id": 1, + "name": "…", + "sort": 1, + "hasPackages": true, + "isReverse": true + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid input or missing fields — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 409 | Carrier already exists — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/carrier/_id.delete.md b/docs/api/routes/carrier/_id.delete.md new file mode 100644 index 0000000..0e856cb --- /dev/null +++ b/docs/api/routes/carrier/_id.delete.md @@ -0,0 +1,37 @@ +# `DELETE /carrier/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Delete carrier + +Deletes a carrier for the selected company, unless referenced in shipping. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | Carrier ID | + +## Signals + +On success, emits SSE signal: `carrier` (see [`GET /events`](../events.md)). + +## Response `204` + +Carrier deleted + +_No content_ + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid ID or no company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 404 | Carrier not found — `{"error":"…"}` | +| 409 | Carrier in use in shipping — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/carrier/_id.get.md b/docs/api/routes/carrier/_id.get.md new file mode 100644 index 0000000..de2b725 --- /dev/null +++ b/docs/api/routes/carrier/_id.get.md @@ -0,0 +1,42 @@ +# `GET /carrier/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Get carrier by ID + +Retrieves a single carrier for the authenticated user's selected company. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | Carrier ID | + +## Response `200` + +Carrier details + +```json +{ + "carrier": { + "id": 1, + "name": "…", + "sort": 1, + "hasPackages": true, + "isReverse": true + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid ID or no company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 404 | Carrier not found — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/carrier/_id.patch.md b/docs/api/routes/carrier/_id.patch.md new file mode 100644 index 0000000..c77bf09 --- /dev/null +++ b/docs/api/routes/carrier/_id.patch.md @@ -0,0 +1,65 @@ +# `PATCH /carrier/{id}` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Update carrier + +Updates carrier name, sort order, hasPackages, and/or isReverse for the selected company. + +## Path parameters + +| Param | Required | Type | Description | +|-------|----------|------|-------------| +| `id` | yes | integer | Carrier ID | + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `name` | no | string | | +| `sort` | no | integer | | +| `hasPackages` | no | boolean | | +| `isReverse` | no | boolean | | + +```json +{ + "name": "…", + "sort": 1, + "hasPackages": true, + "isReverse": true +} +``` + +## Signals + +On success, emits SSE signal: `carrier` (see [`GET /events`](../events.md)). + +## Response `200` + +Updated carrier + +```json +{ + "carrier": { + "id": 1, + "name": "…", + "sort": 1, + "hasPackages": true, + "isReverse": true + } +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid input or missing fields — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | +| 404 | Carrier not found — `{"error":"…"}` | +| 409 | Carrier already exists — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/carrier/order.md b/docs/api/routes/carrier/order.md new file mode 100644 index 0000000..09199b8 --- /dev/null +++ b/docs/api/routes/carrier/order.md @@ -0,0 +1,51 @@ +# `PUT /carrier/order` + +Protected. Requires a valid session cookie (`credentials: 'include'`). + +Reorder carriers + +Reorders carriers for the selected company. +`carrierIds` must include all existing carrier IDs exactly once. + + +## Body (JSON) + +| Field | Required | Type | Description | +|-------|----------|------|-------------| +| `carrierIds` | yes | integer[] | | + +```json +{ + "carrierIds": [ + 1 + ] +} +``` + +## Signals + +On success, emits SSE signal: `carrier` (see [`GET /events`](../events.md)). + +## Response `200` + +Applied carrier order + +```json +{ + "carrierIds": [ + 1 + ] +} +``` + +## Errors + +| Status | Description | +|--------|-------------| +| 400 | Invalid carrier order or no company selected — `{"error":"…"}` | +| 401 | Unauthorized — `{"error":"…"}` | +| 403 | Not authorized — `{"error":"…"}` | + +--- + +_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._ diff --git a/docs/api/routes/order/_id/shipment.get.md b/docs/api/routes/order/_id/shipment.get.md index d8d9d03..10b3049 100644 --- a/docs/api/routes/order/_id/shipment.get.md +++ b/docs/api/routes/order/_id/shipment.get.md @@ -48,6 +48,7 @@ List of shipments "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/_id/shipment.post.md b/docs/api/routes/order/_id/shipment.post.md index 6df073e..23747af 100644 --- a/docs/api/routes/order/_id/shipment.post.md +++ b/docs/api/routes/order/_id/shipment.post.md @@ -88,6 +88,7 @@ Created shipment "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/_id/shipping.get.md b/docs/api/routes/order/_id/shipping.get.md index 1174218..22e75a8 100644 --- a/docs/api/routes/order/_id/shipping.get.md +++ b/docs/api/routes/order/_id/shipping.get.md @@ -24,6 +24,7 @@ List of shippings "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/_id/shipping.post.md b/docs/api/routes/order/_id/shipping.post.md index 386e7ce..cfc62ec 100644 --- a/docs/api/routes/order/_id/shipping.post.md +++ b/docs/api/routes/order/_id/shipping.post.md @@ -19,14 +19,18 @@ If `state` is `shipped`, stock is adjusted via the ledger and article history is | Field | Required | Type | Description | |-------|----------|------|-------------| +| `carrierId` | yes | integer | Carrier ID | | `type` | yes | string | | | `state` | yes | string | | +| `trackingCode` | no | string | Carrier parcel tracking code | | `warehouseId` | no | integer | Optional warehouse ID for stock deduction when state is shipped | ```json { + "carrierId": 1, "type": "…", "state": "…", + "trackingCode": "…", "warehouseId": 1 } ``` @@ -42,6 +46,7 @@ Created shipping "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/create.md b/docs/api/routes/order/create.md index 955d30e..ac15158 100644 --- a/docs/api/routes/order/create.md +++ b/docs/api/routes/order/create.md @@ -70,6 +70,7 @@ Created order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -80,6 +81,7 @@ Created order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -138,6 +140,7 @@ Created order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/get.md b/docs/api/routes/order/get.md index 4496929..1199285 100644 --- a/docs/api/routes/order/get.md +++ b/docs/api/routes/order/get.md @@ -44,6 +44,7 @@ Order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -54,6 +55,7 @@ Order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -112,6 +114,7 @@ Order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/list.md b/docs/api/routes/order/list.md index d5fdcfc..644da1d 100644 --- a/docs/api/routes/order/list.md +++ b/docs/api/routes/order/list.md @@ -53,6 +53,7 @@ Order list "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -63,6 +64,7 @@ Order list "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -121,6 +123,7 @@ Order list "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/order/update.md b/docs/api/routes/order/update.md index bc0dc8e..baedc9e 100644 --- a/docs/api/routes/order/update.md +++ b/docs/api/routes/order/update.md @@ -64,6 +64,7 @@ Updated order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -74,6 +75,7 @@ Updated order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -132,6 +134,7 @@ Updated order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/quote/order.md b/docs/api/routes/quote/order.md index 2a85119..b5ab548 100644 --- a/docs/api/routes/quote/order.md +++ b/docs/api/routes/quote/order.md @@ -82,6 +82,7 @@ Created order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -92,6 +93,7 @@ Created order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" @@ -150,6 +152,7 @@ Created order "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/shipment/_id.get.md b/docs/api/routes/shipment/_id.get.md index ca7b86a..9eab5d0 100644 --- a/docs/api/routes/shipment/_id.get.md +++ b/docs/api/routes/shipment/_id.get.md @@ -47,6 +47,7 @@ Shipment details "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/shipment/_id.patch.md b/docs/api/routes/shipment/_id.patch.md index e05b79f..2bc4dd9 100644 --- a/docs/api/routes/shipment/_id.patch.md +++ b/docs/api/routes/shipment/_id.patch.md @@ -65,6 +65,7 @@ Updated shipment "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/shipment/_id/shipping.get.md b/docs/api/routes/shipment/_id/shipping.get.md index d15678f..505fb68 100644 --- a/docs/api/routes/shipment/_id/shipping.get.md +++ b/docs/api/routes/shipment/_id/shipping.get.md @@ -24,6 +24,7 @@ List of packages "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/shipment/_id/shipping.post.md b/docs/api/routes/shipment/_id/shipping.post.md index 5455d53..135dba5 100644 --- a/docs/api/routes/shipment/_id/shipping.post.md +++ b/docs/api/routes/shipment/_id/shipping.post.md @@ -19,18 +19,18 @@ deducts stock for the shipment's lines via ledger movements. | Field | Required | Type | Description | |-------|----------|------|-------------| +| `carrierId` | yes | integer | Carrier ID | | `type` | yes | string | | | `state` | yes | string | | | `trackingCode` | no | string | Carrier parcel tracking code | -| `carrier` | no | string | Carrier name (e.g. DHL, UPS, DPD) | | `warehouseId` | no | integer | Optional warehouse ID for stock deduction when state is shipped | ```json { + "carrierId": 1, "type": "…", "state": "…", "trackingCode": "…", - "carrier": "…", "warehouseId": 1 } ``` @@ -46,6 +46,7 @@ Created package "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/docs/api/routes/shipping/_id.patch.md b/docs/api/routes/shipping/_id.patch.md index 72c22ce..50de69e 100644 --- a/docs/api/routes/shipping/_id.patch.md +++ b/docs/api/routes/shipping/_id.patch.md @@ -21,7 +21,7 @@ via ledger and article history is written. Once shipped, it cannot be undone. | `type` | no | string | | | `state` | no | string | | | `trackingCode` | no | string | Carrier parcel tracking code | -| `carrier` | no | string | Carrier name (e.g. DHL, UPS, DPD) | +| `carrierId` | no | integer | Carrier ID | | `warehouseId` | no | integer | Warehouse ID for stock deduction when transitioning to shipped | ```json @@ -29,7 +29,7 @@ via ledger and article history is written. Once shipped, it cannot be undone. "type": "…", "state": "…", "trackingCode": "…", - "carrier": "…", + "carrierId": 1, "warehouseId": 1 } ``` @@ -45,6 +45,7 @@ Updated shipping "manifestId": 1, "number": "…", "trackingCode": "…", + "carrierId": 1, "carrier": "…", "type": "…", "state": "…" diff --git a/src/api/openapi.js b/src/api/openapi.js index ea57860..4c1eaf3 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -1249,9 +1249,60 @@ * type: string * amount: * type: number + * Carrier: + * type: object + * required: [id, name, sort, hasPackages, isReverse] + * properties: + * id: + * type: integer + * name: + * type: string + * sort: + * type: integer + * description: Sort order + * hasPackages: + * type: boolean + * description: Whether this carrier uses packages + * isReverse: + * type: boolean + * description: Whether this carrier handles reverse shipments + * CarrierCreateInput: + * type: object + * required: [name] + * properties: + * name: + * type: string + * sort: + * type: integer + * description: Optional sort order + * hasPackages: + * type: boolean + * default: false + * isReverse: + * type: boolean + * default: false + * CarrierUpdateInput: + * type: object + * properties: + * name: + * type: string + * sort: + * type: integer + * hasPackages: + * type: boolean + * isReverse: + * type: boolean + * CarrierOrderInput: + * type: object + * required: [carrierIds] + * properties: + * carrierIds: + * type: array + * items: + * type: integer * Shipping: * type: object - * required: [id, manifestId, number, type, state] + * required: [id, manifestId, number, carrierId, type, state] * properties: * id: * type: integer @@ -1264,6 +1315,9 @@ * type: string * nullable: true * description: Carrier parcel tracking code + * carrierId: + * type: integer + * description: Carrier ID * carrier: * type: string * nullable: true diff --git a/src/api/routes/carrier.js b/src/api/routes/carrier.js new file mode 100644 index 0000000..e18a551 --- /dev/null +++ b/src/api/routes/carrier.js @@ -0,0 +1,505 @@ +import * as db from '../../db/carrier.js'; +import { emit } from '../sse.js'; + +// #region Helpers + +function requireSelectedCompany(req) { + const companyId = req.user?.selectedCompanyId; + if (companyId == null) { + return { error: 'No company selected' }; + } + return { companyId }; +} + +function parsePositiveInt(val, field = 'id') { + const id = Number(val); + if (!Number.isInteger(id) || id <= 0) { + return { error: `${field} is required` }; + } + return { id }; +} + +function carrierErrorStatus(error) { + if (error.message === 'No company selected') return 400; + if (error.message === 'Not authorized') return 403; + if (error.message === 'Company not found') return 404; + if (error.message === 'Carrier not found') return 404; + if (error.message === 'Name required') return 400; + if (error.message === 'Carrier already exists') return 409; + if (error.message === 'Carrier in use') return 409; + if (error.message === 'Invalid carrier order') return 400; + if (error.message === 'Invalid sort') return 400; + return 500; +} + +// #endregion + +/** + * Registers carrier routes for the authenticated user's selected company. + * @param {import('express').Application} app + * @param {string} [basePath=''] + */ +export function register(app, basePath = '') { + /** + * @openapi + * /carrier: + * get: + * tags: [Carrier] + * summary: List carriers + * description: Lists carriers for the selected company, ordered by sort and name. + * security: + * - cookieAuth: [] + * responses: + * 200: + * description: List of carriers + * content: + * application/json: + * schema: + * type: object + * properties: + * carriers: + * type: array + * items: + * $ref: '#/components/schemas/Carrier' + * 400: + * description: No company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region GET /carrier + + app.get(`${basePath}/carrier`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + try { + const carriers = await db.list(req.user.id); + res.status(200).json({ carriers }); + } catch (error) { + const status = carrierErrorStatus(error); + if (status === 500) console.error('List carriers failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /carrier/order: + * put: + * tags: [Carrier] + * summary: Reorder carriers + * description: | + * Reorders carriers for the selected company. + * `carrierIds` must include all existing carrier IDs exactly once. + * security: + * - cookieAuth: [] + * x-signals: [carrier] + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/CarrierOrderInput' + * responses: + * 200: + * description: Applied carrier order + * content: + * application/json: + * schema: + * type: object + * properties: + * carrierIds: + * type: array + * items: + * type: integer + * 400: + * description: Invalid carrier order or no company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region PUT /carrier/order + + app.put(`${basePath}/carrier/order`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const { carrierIds } = req.body ?? {}; + + try { + const result = await db.order(req.user.id, { carrierIds }); + emit('carrier', { companyId: selected.companyId }); + res.status(200).json(result); + } catch (error) { + const status = carrierErrorStatus(error); + if (status === 500) console.error('Order carriers failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /carrier/{id}: + * get: + * tags: [Carrier] + * summary: Get carrier by ID + * description: Retrieves a single carrier for the authenticated user's selected company. + * security: + * - cookieAuth: [] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * description: Carrier ID + * responses: + * 200: + * description: Carrier details + * content: + * application/json: + * schema: + * type: object + * properties: + * carrier: + * $ref: '#/components/schemas/Carrier' + * 400: + * description: Invalid ID or no company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Carrier not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region GET /carrier/:id + + app.get(`${basePath}/carrier/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsedId = parsePositiveInt(req.params.id, 'id'); + if (parsedId.error) { + return res.status(400).json({ error: parsedId.error }); + } + + try { + const carrier = await db.getById(req.user.id, parsedId.id); + if (!carrier) { + return res.status(404).json({ error: 'Carrier not found' }); + } + res.status(200).json({ carrier }); + } catch (error) { + const status = carrierErrorStatus(error); + if (status === 500) console.error('Get carrier failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + /** + * @openapi + * /carrier: + * post: + * tags: [Carrier] + * summary: Create carrier + * description: | + * Creates a new carrier for the selected company. + * Sort order will be automatically appended if omitted. + * security: + * - cookieAuth: [] + * x-signals: [carrier] + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/CarrierCreateInput' + * responses: + * 201: + * description: Created carrier + * content: + * application/json: + * schema: + * type: object + * properties: + * carrier: + * $ref: '#/components/schemas/Carrier' + * 400: + * description: Invalid input or missing fields + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 409: + * description: Carrier already exists + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region POST /carrier + + app.post(`${basePath}/carrier`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const { name, sort, hasPackages, isReverse } = req.body ?? {}; + + try { + const carrier = await db.create(req.user.id, { name, sort, hasPackages, isReverse }); + emit('carrier', { companyId: selected.companyId }); + res.status(201).json({ carrier }); + } catch (error) { + const status = carrierErrorStatus(error); + if (status === 500) console.error('Create carrier failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion + + async function handleUpdate(req, res) { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsedId = parsePositiveInt(req.params.id, 'id'); + if (parsedId.error) { + return res.status(400).json({ error: parsedId.error }); + } + + const { name, sort, hasPackages, isReverse } = req.body ?? {}; + + try { + const carrier = await db.update(req.user.id, parsedId.id, { + ...(name !== undefined ? { name } : {}), + ...(sort !== undefined ? { sort } : {}), + ...(hasPackages !== undefined ? { hasPackages } : {}), + ...(isReverse !== undefined ? { isReverse } : {}), + }); + emit('carrier', { companyId: selected.companyId }); + res.status(200).json({ carrier }); + } catch (error) { + const status = carrierErrorStatus(error); + if (status === 500) console.error('Update carrier failed:', error); + res.status(status).json({ error: error.message }); + } + } + + /** + * @openapi + * /carrier/{id}: + * patch: + * tags: [Carrier] + * summary: Update carrier + * description: Updates carrier name, sort order, hasPackages, and/or isReverse for the selected company. + * security: + * - cookieAuth: [] + * x-signals: [carrier] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * description: Carrier ID + * requestBody: + * required: true + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/CarrierUpdateInput' + * responses: + * 200: + * description: Updated carrier + * content: + * application/json: + * schema: + * type: object + * properties: + * carrier: + * $ref: '#/components/schemas/Carrier' + * 400: + * description: Invalid input or missing fields + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Carrier not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 409: + * description: Carrier already exists + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region PATCH /carrier/:id + + app.patch(`${basePath}/carrier/:id`, handleUpdate); + + // #endregion + + /** + * @openapi + * /carrier/{id}: + * delete: + * tags: [Carrier] + * summary: Delete carrier + * description: Deletes a carrier for the selected company, unless referenced in shipping. + * security: + * - cookieAuth: [] + * x-signals: [carrier] + * parameters: + * - in: path + * name: id + * required: true + * schema: + * type: integer + * description: Carrier ID + * responses: + * 204: + * description: Carrier deleted + * 400: + * description: Invalid ID or no company selected + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 401: + * description: Unauthorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 403: + * description: Not authorized + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 404: + * description: Carrier not found + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + * 409: + * description: Carrier in use in shipping + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/Error' + */ + // #region DELETE /carrier/:id + + app.delete(`${basePath}/carrier/:id`, async (req, res) => { + const selected = requireSelectedCompany(req); + if (selected.error) { + return res.status(400).json({ error: selected.error }); + } + + const parsedId = parsePositiveInt(req.params.id, 'id'); + if (parsedId.error) { + return res.status(400).json({ error: parsedId.error }); + } + + try { + await db.remove(req.user.id, parsedId.id); + emit('carrier', { companyId: selected.companyId }); + res.status(204).end(); + } catch (error) { + const status = carrierErrorStatus(error); + if (status === 500) console.error('Delete carrier failed:', error); + res.status(status).json({ error: error.message }); + } + }); + + // #endregion +} diff --git a/src/api/routes/shipping.js b/src/api/routes/shipping.js index 5a7fa9f..eb58bd8 100644 --- a/src/api/routes/shipping.js +++ b/src/api/routes/shipping.js @@ -151,12 +151,18 @@ export function register(app, basePath = '') { * application/json: * schema: * type: object - * required: [type, state] + * required: [carrierId, type, state] * properties: + * carrierId: + * type: integer + * description: Carrier ID * type: * type: string * state: * type: string + * trackingCode: + * type: string + * description: Carrier parcel tracking code * warehouseId: * type: integer * description: Optional warehouse ID for stock deduction when state is shipped @@ -329,8 +335,11 @@ export function register(app, basePath = '') { * application/json: * schema: * type: object - * required: [type, state] + * required: [carrierId, type, state] * properties: + * carrierId: + * type: integer + * description: Carrier ID * type: * type: string * state: @@ -338,9 +347,6 @@ export function register(app, basePath = '') { * trackingCode: * type: string * description: Carrier parcel tracking code - * carrier: - * type: string - * description: Carrier name (e.g. DHL, UPS, DPD) * warehouseId: * type: integer * description: Optional warehouse ID for stock deduction when state is shipped @@ -436,9 +442,9 @@ export function register(app, basePath = '') { * trackingCode: * type: string * description: Carrier parcel tracking code - * carrier: - * type: string - * description: Carrier name (e.g. DHL, UPS, DPD) + * carrierId: + * type: integer + * description: Carrier ID * warehouseId: * type: integer * description: Warehouse ID for stock deduction when transitioning to shipped diff --git a/src/db/carrier.js b/src/db/carrier.js new file mode 100644 index 0000000..8e2aab2 --- /dev/null +++ b/src/db/carrier.js @@ -0,0 +1,31 @@ +import { getStore } from './store.js'; + +export async function list(googleAuthId) { + const store = await getStore(); + return store.carrier.list(googleAuthId); +} + +export async function getById(googleAuthId, id) { + const store = await getStore(); + return store.carrier.getById(googleAuthId, id); +} + +export async function create(googleAuthId, data) { + const store = await getStore(); + return store.carrier.create(googleAuthId, data); +} + +export async function update(googleAuthId, id, data) { + const store = await getStore(); + return store.carrier.update(googleAuthId, id, data); +} + +export async function order(googleAuthId, data) { + const store = await getStore(); + return store.carrier.order(googleAuthId, data); +} + +export async function remove(googleAuthId, id) { + const store = await getStore(); + return store.carrier.delete(googleAuthId, id); +} diff --git a/src/services/companyImport/orderImporter.js b/src/services/companyImport/orderImporter.js index 8fa8d60..78d2cef 100644 --- a/src/services/companyImport/orderImporter.js +++ b/src/services/companyImport/orderImporter.js @@ -137,6 +137,42 @@ export async function importOrders({ } }; + const carrierMap = new Map(); + try { + const carriers = await store.carrier.list(googleAuthId); + for (const c of carriers) { + if (c.name) { + carrierMap.set(c.name.trim().toLowerCase(), c.id); + } + } + } catch (err) { + log.warn('Could not list carriers:', err.message); + } + + const resolveCarrierId = async (name) => { + const cleanName = (name || '').trim() || 'Standard'; + const key = cleanName.toLowerCase(); + if (carrierMap.has(key)) return carrierMap.get(key); + + try { + const carrier = await store.carrier.create(googleAuthId, { + name: cleanName, + hasPackages: true, + }); + carrierMap.set(key, carrier.id); + return carrier.id; + } catch (err) { + const list = await store.carrier.list(googleAuthId).catch(() => []); + const found = list.find((c) => c.name.trim().toLowerCase() === key); + if (found) { + carrierMap.set(key, found.id); + return found.id; + } + log.warn(`Could not create carrier "${cleanName}":`, err.message); + return null; + } + }; + const processManifest = async (m) => { const orderNumber = cleanValue(m.nr ?? m.cAuftragsNr); if (!orderNumber || existingOrderNumbers.has(orderNumber)) { @@ -282,18 +318,21 @@ export async function importOrders({ if (!isSelbstabholer) { const trackingCode = cleanValue(m.trackingCode ?? m.tracking_code ?? m.cTracking); - const carrier = cleanValue(m.carrier ?? m.cCarrier); + const carrierName = cleanValue(m.carrier ?? m.cCarrier) || 'Standard'; + const carrierId = await resolveCarrierId(carrierName); const shippingState = isShipped ? 'shipped' : 'draft'; - await store.shipping.create(googleAuthId, { - manifestId: shipment.id, - type: shippingType || 'standard', - state: shippingState, - trackingCode: trackingCode || undefined, - carrier: carrier || undefined, - warehouseId: defaultWarehouseId || undefined, - }); - shippingsImported++; + if (carrierId) { + await store.shipping.create(googleAuthId, { + manifestId: shipment.id, + carrierId, + type: shippingType || 'standard', + state: shippingState, + trackingCode: trackingCode || undefined, + warehouseId: defaultWarehouseId || undefined, + }); + shippingsImported++; + } } } catch (err) { log.warn(`Failed to create shipment/shipping for order ${orderNumber}:`, err.message);