From de6c4987b936e948dbbcf10913861fefce805e6b Mon Sep 17 00:00:00 2001 From: seb Date: Fri, 16 Oct 2026 18:04:42 +0200 Subject: [PATCH] u --- docs/api/routes-all.md | 222 +++++++++--------- docs/api/routes.md | 190 ++++++++------- docs/api/routes/modelconversation.get.md | 2 +- docs/api/routes/modelconversation.post.md | 2 +- docs/api/routes/modelconversation/_id.get.md | 2 +- .../routes/public/_companyId/articles/_sku.md | 61 ++++- docs/api/routes/supplier/articles.get.md | 2 +- scripts/generateApiDocs.js | 39 ++- src/api/openapi.js | 6 +- src/api/routes/publicCatalog.js | 62 ++++- src/api/routes/supplier.js | 6 +- 11 files changed, 358 insertions(+), 236 deletions(-) diff --git a/docs/api/routes-all.md b/docs/api/routes-all.md index c48f36b..ad7494c 100644 --- a/docs/api/routes-all.md +++ b/docs/api/routes-all.md @@ -10,15 +10,15 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types - `T1` = `{ order: T2 }` -- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T30[], externalNumber?: str|null, createdAt?: str, shipping?: T38|null, shippings?: T38[], payment?: T44|null, payments?: T44[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T16[] }` +- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T29[], externalNumber?: str|null, createdAt?: str, shipping?: T36|null, shippings?: T36[], payment?: T42|null, payments?: T42[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T16[] }` - `T3` = `{ article: T4 }` -- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T41, brand: T39|null, categoryIds: int[], photos: T36[], eans: str[], prices: T48[], suppliers: T18[] }` +- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T39, brand: T37|null, categoryIds: int[], photos: T34[], eans: str[], prices: T46[], suppliers: T18[] }` - `T5` = `{ shipment: T6 }` -- `T6` = `{ id: int, number: str, type: str, date: str, lines: T30[], shippings: T38[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T16[], state?: str }` +- `T6` = `{ id: int, number: str, type: str, date: str, lines: T29[], shippings: T36[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T16[], state?: str }` - `T7` = `{ quote: T8 }` -- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T30[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T16[] }` +- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T29[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T16[] }` - `T9` = `{ delivery: T10 }` -- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T30[], files: T16[], externalNumber?: str|null, createdAt?: str, ledger?: T52 }` +- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T29[], files: T16[], externalNumber?: str|null, createdAt?: str, ledger?: T50 }` - `T11` = `{ name: str, path: str, totalSizeBytes: int, timestamp: str|null, manifest?: T12|null }` - `T12` = `{ id: str, timestamp: str, dateKey: str, monthKey: str, dbProvider: str, files: T19, totalSizeBytes: int, durationMs: int }` - `T13` = `{ labeltemplate: T15 }` @@ -26,46 +26,44 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). - `T15` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T26, thumb?: str|null }` - `T16` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` - `T17` = `{ id: int, name: str, pairingpin?: str|null, token?: str|null, pairedAt?: str|null, clientserial?: str|null, rootCategoryId?: int|null, syncRootArticles?: bool, lastseenAt?: str|null, updatedAt?: str|null, categoryIds?: int[] }` -- `T18` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T55|null }` -- `T19` = `{ vfs: T53, storage: T53, database: T46 }` +- `T18` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T53|null }` +- `T19` = `{ vfs: T51, storage: T51, database: T44 }` - `T20` = `{ 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 }` - `T21` = `{ ledger: T22[] }` - `T22` = `{ 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 }` -- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, values: T42[], articleCount?: int }` -- `T24` = `{ id: int, companyuser_id: int, provider: str, model: str, created_at: str, updated_at: str, state: str, started_by?: integer,null, first_message?: string,null }` +- `T23` = `{ id: int, name: str, sort: int, exclusive: bool, values: T40[], articleCount?: int }` +- `T24` = `{ 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 }` - `T25` = `{ id: int, name: str, rootCategoryId: int|null, languageId: int|null, iso639: str|null, taxrate: num, reducedtaxrate: num, taxfreerate: num }` -- `T26` = `{ objects: T31[] }` -- `T27` = `{ objects: T32[] }` -- `T28` = `{ printer: T34 }` -- `T29` = `{ entity: T37 }` -- `T30` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T31` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T32` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T33` = `{ shipping: T38 }` -- `T34` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T35` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T36` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T37` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T38` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T39` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T40` = `{ article: T45 }` -- `T41` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T42` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T43` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T44` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T45` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T46` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` -- `T47` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` -- `T48` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T49` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T50` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T51` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T52` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T53` = `{ name: str, sizeBytes: int, sourceExists: bool }` -- `T54` = `{ warehouse: T56 }` -- `T55` = `{ net: num, taxId: int, taxRate?: num|null }` -- `T56` = `{ id: int, name: str, sort: int }` -- `T57` = `{ id: int, categoryIds: int[] }` +- `T26` = `{ objects: T30[] }` +- `T27` = `{ printer: T32 }` +- `T28` = `{ entity: T35 }` +- `T29` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T30` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T31` = `{ shipping: T36 }` +- `T32` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T33` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T34` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T35` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T36` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T37` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T38` = `{ article: T43 }` +- `T39` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T40` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T41` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T42` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T43` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` +- `T44` = `{ name: str|null, sizeBytes: int, backedUp: bool, reason?: str|null }` +- `T45` = `{ id: int, email: str, selectedCompanyId: int|null, picture?: str }` +- `T46` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` +- `T47` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T48` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T49` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T50` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T51` = `{ name: str, sizeBytes: int, sourceExists: bool }` +- `T52` = `{ warehouse: T54 }` +- `T53` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T54` = `{ id: int, name: str, sort: int }` +- `T55` = `{ id: int, categoryIds: int[] }` ### Routes @@ -95,7 +93,7 @@ _none_ #### Create article in category — `POST /article` - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }` -- Returns: `201 T40` +- Returns: `201 T38` #### Export articles as ZIP — `GET /article/export.zip` - Params: `query: categoryId?: int` - Returns: `200 zip` @@ -131,10 +129,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 T40` +- Returns: `201 T38` #### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children` - Params: `sku: str, body: { sku: str, attributeValueId?: int, value?: str, reparent?: bool }` -- Returns: `200 { article: T45, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T43, 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 }` @@ -161,7 +159,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 T40` +- Returns: `200 T38` #### Replace POS prices by SKU (net > gross; price=net, tax=taxRate %) — `PUT /article/{sku}/prices` - Params: `sku: str, body: { prices: { net?: num, gross?: num, price?: num, taxRate?: num, tax?: num, minmultiplier?: num }[] }` - Returns: `200 T3` @@ -212,10 +210,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T42[] }` +- Returns: `200 { values: T40[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T42 }` +- Returns: `201 { attributevalue: T40 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -233,28 +231,28 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T42 }` +- Returns: `200 { attributevalue: T40 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T49[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T47[] } }` #### Add or replace attribute value image — `POST /attributevalue/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T49[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T47[] } }` ### Section: /auth #### Login with Google ID token — `POST /auth/login` - Params: `body: { idToken: str }` -- Returns: `200 { message: str, user: T47 }` +- Returns: `200 { message: str, user: T45 }` #### Logout — `POST /auth/logout` _none_ - Returns: `200 { message: str }` #### Current user — `GET /auth/me` _none_ -- Returns: `200 { user: T47, googleClientId: str }` +- Returns: `200 { user: T45, googleClientId: str }` #### Set selected company — `PUT /auth/selected-company` - Params: `body: { companyId: int }` -- Returns: `200 { user: T47 }` +- Returns: `200 { user: T45 }` ### Section: /backup @@ -275,7 +273,7 @@ _none_ - Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }` #### Create brand — `POST /brand` - Params: `body: { name: str, gsprpinfo?: str }` -- Returns: `201 { brand: { id: int, name: str, pics: T49[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T47[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -284,10 +282,10 @@ _none_ - Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }` #### Delete brand image — `DELETE /brand/{id}/image` - Params: `id: int` -- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T49[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T47[] } }` #### Add or replace brand image — `POST /brand/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T49[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T47[] } }` ### Section: /category @@ -311,7 +309,7 @@ _none_ - Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }` #### Articles in category — `GET /category/{id}/articles` - Params: `id: int` -- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, brand?: T39|null }[] }` +- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, brand?: T37|null }[] }` #### List category attribute values — `GET /category/{id}/attributevalue` - Params: `id: int` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` @@ -341,7 +339,7 @@ _none_ - Returns: `200 { companies: T25[] }` #### Create company — `POST /company` - Params: `body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }` -- Returns: `201 { company: T25, user: T47 }` +- Returns: `201 { company: T25, user: T45 }` #### Export company catalog as zip archive (SSE) — `GET /company/export` - Params: `query: stream?: str` - Returns: `200 SSE` @@ -380,7 +378,7 @@ _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` -- Returns: `201 { customergroup: T56 }` +- Returns: `201 { customergroup: T54 }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` @@ -389,15 +387,15 @@ _none_ - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { customergroup: T56 }` +- Returns: `200 { customergroup: T54 }` ### Section: /delivery #### List deliveries — `GET /delivery` _none_ -- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T52 }[] }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T50 }[] }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T35[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `body: { externalNumber: str, date: str, lines: T33[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 T9` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -406,7 +404,7 @@ _none_ - Params: `id: int` - Returns: `200 T9` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T35[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T33[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 T9` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -422,10 +420,10 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T37[] }` +- Returns: `200 { entities: T35[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 T29` +- Returns: `201 T28` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` @@ -443,25 +441,25 @@ _none_ - Returns: `200 { address: T20 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T50[] }` +- Returns: `200 { contacts: T48[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T50 }` +- Returns: `201 { contact: T48 }` #### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity contact — `PATCH /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }` -- Returns: `200 { contact: T50 }` +- Returns: `200 { contact: T48 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 T29` +- Returns: `200 T28` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 T29` +- Returns: `200 T28` ### Section: /events @@ -503,7 +501,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: T27 }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: T26 }` - Returns: `201 T13` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -512,10 +510,10 @@ _none_ - Params: `id: int` - Returns: `200 T13` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T27 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T26 }` - Returns: `200 T13` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T27 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T26 }` - Returns: `200 T13` ### Section: /ledger @@ -611,7 +609,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, lines: T35[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T33[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T1` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -620,7 +618,7 @@ _none_ - Params: `id: int` - Returns: `200 T1` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T33[] }` - Returns: `200 T1` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -630,10 +628,10 @@ _none_ - Returns: `200 str` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T44[] }` +- Returns: `200 { payments: T42[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T44 }` +- Returns: `201 { payment: T42 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 T14` @@ -645,10 +643,10 @@ _none_ - Returns: `201 T5` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T38[] }` +- Returns: `200 { shippings: T36[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 T33` +- Returns: `201 T31` ### Section: /package @@ -678,25 +676,25 @@ _none_ - Returns: `200 { posterminal: T17 }` #### Disable all categories on terminal — `DELETE /posterminal/{id}/all` - Params: `id: int` -- Returns: `200 T57` +- Returns: `200 T55` #### Enable all categories on terminal — `PUT /posterminal/{id}/all` - Params: `id: int` -- Returns: `200 T57` +- Returns: `200 T55` #### Disable category on terminal — `DELETE /posterminal/{id}/category/{categoryId}` - Params: `id: int, categoryId: int` -- Returns: `200 T57` +- Returns: `200 T55` #### Enable category on terminal — `PUT /posterminal/{id}/category/{categoryId}` - Params: `id: int, categoryId: int` -- Returns: `200 T57` +- Returns: `200 T55` ### Section: /printer #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T34[] }` +- Returns: `200 { printers: T32[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 T28` +- Returns: `201 T27` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -705,22 +703,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 T28` +- Returns: `200 T27` #### 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 T28` +- Returns: `200 T27` #### 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 T28` +- Returns: `200 T27` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T43[] }` +- Returns: `200 { propertynames: T41[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T43 }` +- Returns: `201 { propertyname: T41 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -729,19 +727,19 @@ _none_ - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { propertyname: T43 }` +- Returns: `200 { propertyname: T41 }` ### Section: /public #### Receipt crash dump — `POST /public/telemetry/crash` -- Params: `body: { content: any }` +- Params: `body: { content: str|{} }` - Returns: `200 { ok: bool, filename: str }` #### List public articles — `GET /public/{companyId}/articles` - Params: `companyId: int, query: categoryId?: int, search?: str, limit?: int, offset?: int` - 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: {}|null, brand: {}|null, price: {}|null, prices: {}[], categories: {}[], photos: {}[], eans: str[], isParent: bool, parentSku: str|null, variants: {}[] } }` +- Returns: `200 { article: { id: int, sku: str, name: str, slug: str, description: str, unitamount: num|null, weight: num|null, trackStock: bool, unit: T39|null, brand: T37|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: T34[], 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 }[] }` @@ -752,7 +750,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T8[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T35[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T33[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T7` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -761,7 +759,7 @@ _none_ - Params: `id: int` - Returns: `200 T7` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T35[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T33[] }` - Returns: `200 T7` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -770,7 +768,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?: T35[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T33[] }` - Returns: `201 T1` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -816,10 +814,10 @@ _none_ - Returns: `201 T14` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T38[] }` +- Returns: `200 { shippings: T36[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 T33` +- Returns: `201 T31` ### Section: /shipping @@ -828,7 +826,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 T33` +- Returns: `200 T31` #### 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 }[] }` @@ -852,22 +850,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T51[] }` +- Returns: `200 { suppliers: T49[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T51 }` +- Returns: `201 { supplier: T49 }` #### Delete supplier — `DELETE /supplier/{id}` - Params: `id: int` - Returns: `204 void` #### Update supplier — `PATCH /supplier/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { supplier: T51 }` +- Returns: `200 { supplier: T49 }` #### List supplier articles by SKUs — `GET /supplier/{id}/articles` -- Params: `id: int, query: skus?: string` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T55|null }[] }` +- 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?: T53|null }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T55|null }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T53|null }[] }` ### Section: /thumb @@ -882,10 +880,10 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T41[] }` +- Returns: `200 { units: T39[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T41 }` +- Returns: `200 { unit: T39 }` ### Section: /v1 @@ -942,10 +940,10 @@ _none_ #### List warehouses — `GET /warehouse` _none_ -- Returns: `200 { warehouses: T56[] }` +- Returns: `200 { warehouses: T54[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` -- Returns: `201 T54` +- Returns: `201 T52` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` @@ -954,10 +952,10 @@ _none_ - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` -- Returns: `200 T54` +- Returns: `200 T52` #### Update warehouse (partial) — `PATCH /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T54` +- Returns: `200 T52` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T54` +- Returns: `200 T52` diff --git a/docs/api/routes.md b/docs/api/routes.md index 2b9d6f2..36448b4 100644 --- a/docs/api/routes.md +++ b/docs/api/routes.md @@ -10,52 +10,50 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body). ### Reusable types - `T1` = `{ order: T2 }` -- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T24[], externalNumber?: str|null, createdAt?: str, shipping?: T32|null, shippings?: T32[], payment?: T38|null, payments?: T38[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T14[] }` +- `T2` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T23[], externalNumber?: str|null, createdAt?: str, shipping?: T30|null, shippings?: T30[], payment?: T36|null, payments?: T36[], paid?: bool, shipped?: bool, delivered?: bool, orderTotal?: num, paidTotal?: num, orderedQuantity?: num, shippedQuantity?: num, shipments?: T6[], files?: T14[] }` - `T3` = `{ article: T4 }` -- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T35, brand: T33|null, categoryIds: int[], photos: T30[], eans: str[], prices: T40[], suppliers: T15[] }` +- `T4` = `{ id: int, sku: str, name: str, slug: str, desc: str|null, seo: str|null, track_stock: bool, unitamount: num|null, weight: num|null, unit: T33, brand: T31|null, categoryIds: int[], photos: T28[], eans: str[], prices: T38[], suppliers: T15[] }` - `T5` = `{ shipment: T6 }` -- `T6` = `{ id: int, number: str, type: str, date: str, lines: T24[], shippings: T32[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T14[], state?: str }` +- `T6` = `{ id: int, number: str, type: str, date: str, lines: T23[], shippings: T30[], entityId?: int|null, externalNumber?: str|null, createdAt?: str|null, lineCount?: int, packageCount?: int, files?: T14[], state?: str }` - `T7` = `{ quote: T8 }` -- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T24[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T14[] }` +- `T8` = `{ id: int, number: str, type: str, entityId: int|null, date: str, lines: T23[], externalNumber?: str|null, createdAt?: str, positions?: int, grossTotal?: num, totalQuantity?: num, customerName?: str|null, files?: T14[] }` - `T9` = `{ delivery: T10 }` -- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T24[], files: T14[], externalNumber?: str|null, createdAt?: str, ledger?: T44 }` +- `T10` = `{ id: int, number: str, type: str, supplierId: int|null, date: str, lines: T23[], files: T14[], externalNumber?: str|null, createdAt?: str, ledger?: T42 }` - `T11` = `{ labeltemplate: T13 }` - `T12` = `{ attachment: T14, fileUrl: str }` - `T13` = `{ id: int, name: str, width: num, height: num, dpi: int, type: str, content: T20, thumb?: str|null }` - `T14` = `{ id: int, manifestId: int, fileId: int, sort: int, hash: str, mimetype: str, name: str, size: int, created?: str, modified?: str, skeledash?: str|null, thumbx?: int|null, thumby?: int|null, meta?: { [k]: str }|null }` -- `T15` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T46|null }` +- `T15` = `{ id: int, articleId: int, entityId: int, pu: num, sort: int, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T44|null }` - `T16` = `{ 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 }` - `T17` = `{ ledger: T18[] }` - `T18` = `{ 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 }` -- `T19` = `{ id: int, name: str, sort: int, exclusive: bool, values: T36[], articleCount?: int }` -- `T20` = `{ objects: T25[] }` -- `T21` = `{ objects: T26[] }` -- `T22` = `{ printer: T28 }` -- `T23` = `{ entity: T31 }` -- `T24` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` -- `T25` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T26` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` -- `T27` = `{ shipping: T32 }` -- `T28` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` -- `T29` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` -- `T30` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` -- `T31` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` -- `T32` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` -- `T33` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` -- `T34` = `{ article: T39 }` -- `T35` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` -- `T36` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` -- `T37` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` -- `T38` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` -- `T39` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` -- `T40` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` -- `T41` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` -- `T42` = `{ id: int, entityId: int, contactType: str, contact: str }` -- `T43` = `{ id: int, name: str, createdAt: str, updatedAt: str }` -- `T44` = `{ totalPositions: int, completelyOnLedgerPositions: int }` -- `T45` = `{ warehouse: T47 }` -- `T46` = `{ net: num, taxId: int, taxRate?: num|null }` -- `T47` = `{ id: int, name: str, sort: int }` +- `T19` = `{ id: int, name: str, sort: int, exclusive: bool, values: T34[], articleCount?: int }` +- `T20` = `{ objects: T24[] }` +- `T21` = `{ printer: T26 }` +- `T22` = `{ entity: T29 }` +- `T23` = `{ id: int, sku: str|null, name: str|null, pu: num, amount: num, net: num, rebate: num, taxrate: num, comment: str|null }` +- `T24` = `{ id: str, type: str, x: num, y: num, w?: num, h?: num, text?: str, font?: str, fontSize?: num, barcodeFormat?: str }` +- `T25` = `{ shipping: T30 }` +- `T26` = `{ id: int, company_id: int, address: str, type: str, sort: int, model?: str|null, serial?: str|null, desc?: str|null }` +- `T27` = `{ amount: num, net: num, taxrate: num, sku?: str|null, name?: str|null, pu?: num, rebate?: num, comment?: str|null }` +- `T28` = `{ sort: int, fullHash: str, fullW: int, fullH: int, fullSize: int, thumbW: int, thumbH: int, thumbHash: str }` +- `T29` = `{ id: int, customergroupId: int, firstName: str|null, name: str, number: str|null, createdAt: str, updatedAt: str }` +- `T30` = `{ id: int, manifestId: int, number: str, type: str, state: str, trackingCode?: str|null, carrier?: str|null }` +- `T31` = `{ name: str, id?: int|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null }` +- `T32` = `{ article: T37 }` +- `T33` = `{ si: str, basesi: str, basesifactor: num, symbol?: str|null, name?: str|null }` +- `T34` = `{ id: int, attributeId: int, value: str, sort: int, articleCount?: int }` +- `T35` = `{ id: int, name: str, sort: int, exclusive: bool, articleCount?: int }` +- `T36` = `{ id: int, accountId: int, manifestId: int, type: str, amount: num }` +- `T37` = `{ id: int, categoryId: int, name: str, sku: str, track_stock: bool }` +- `T38` = `{ minmultiplier: num, net: num, taxRate: num, customergroupId: int }` +- `T39` = `{ fullHash: str, thumbW: int, thumbH: int, thumbHash: str }` +- `T40` = `{ id: int, entityId: int, contactType: str, contact: str }` +- `T41` = `{ id: int, name: str, createdAt: str, updatedAt: str }` +- `T42` = `{ totalPositions: int, completelyOnLedgerPositions: int }` +- `T43` = `{ warehouse: T45 }` +- `T44` = `{ net: num, taxId: int, taxRate?: num|null }` +- `T45` = `{ id: int, name: str, sort: int }` ### Routes @@ -64,7 +62,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 T34` +- Returns: `201 T32` #### Delete article by SKU — `DELETE /article/{sku}` - Params: `sku: str, query: cascade?: bool` - Returns: `204 void` @@ -97,10 +95,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 T34` +- Returns: `201 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: T39, children: { id: int, sku: str, name: str, parentsort: int, attributeValueId: int, attributeValue: str }[] }` +- Returns: `200 { article: T37, 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 }` @@ -124,7 +122,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 T34` +- Returns: `200 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 T3` @@ -175,10 +173,10 @@ _none_ - Returns: `200 { ok: bool }` #### List values for an attribute — `GET /attributename/{attributeId}/value` - Params: `attributeId: int` -- Returns: `200 { values: T36[] }` +- Returns: `200 { values: T34[] }` #### Create value for an attribute — `POST /attributename/{attributeId}/value` - Params: `attributeId: int, body: { value: str, sort?: int }` -- Returns: `201 { attributevalue: T36 }` +- Returns: `201 { attributevalue: T34 }` #### Reorder values of an attribute — `PUT /attributename/{attributeId}/value/order` - Params: `attributeId: int, body: { attributevalueIds: int[] }` - Returns: `200 { ok: bool }` @@ -196,13 +194,13 @@ _none_ - Returns: `200 { ok: bool }` #### Update attribute value — `PATCH /attributevalue/{id}` - Params: `id: int, body: { value?: str, sort?: int }` -- Returns: `200 { attributevalue: T36 }` +- Returns: `200 { attributevalue: T34 }` #### Delete attribute value image — `DELETE /attributevalue/{id}/image` - Params: `id: int` -- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T41[] } }` +- Returns: `200 { attributevalue: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T39[] } }` #### Add or replace attribute value image — `POST /attributevalue/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T41[] } }` +- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T39[] } }` ### Section: /brand @@ -211,7 +209,7 @@ _none_ - Returns: `200 { brands: { id: int, name: str, articleCount: int, pics: { fullHash: str, thumbW: int, thumbH: int, thumbHash: str, smallThumbW?: int|null, smallThumbH?: int|null, smallThumbBinary?: str|null }[], gsprpinfo?: str|null }[], total: int, offset: int, limit: int }` #### Create brand — `POST /brand` - Params: `body: { name: str, gsprpinfo?: str }` -- Returns: `201 { brand: { id: int, name: str, pics: T41[], gsprpinfo?: str|null } }` +- Returns: `201 { brand: { id: int, name: str, pics: T39[], gsprpinfo?: str|null } }` #### Delete brand — `DELETE /brand/{id}` - Params: `id: int` - Returns: `204 void` @@ -220,10 +218,10 @@ _none_ - Returns: `200 { brand: { id: int, name: str, touchedArticleCount: int, gsprpinfo?: str|null } }` #### Delete brand image — `DELETE /brand/{id}/image` - Params: `id: int` -- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T41[] } }` +- Returns: `200 { brand: { id: int, thumbW: int|null, thumbH: int|null, thumbHash: str|null, pics: T39[] } }` #### Add or replace brand image — `POST /brand/{id}/image` - Params: `id: int, image/avif` -- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T41[] } }` +- Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T39[] } }` ### Section: /category @@ -244,7 +242,7 @@ _none_ - Returns: `200 { category: { id: int, name: str, slug: str, parentId: int, sort: int } }` #### Articles in category — `GET /category/{id}/articles` - Params: `id: int` -- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, brand?: T33|null }[] }` +- Returns: `200 { articles: { id: int, sku: str, name: str, slug: str, track_stock: bool, optionsCount: int, articleListCount: int, childCount: int, net?: num|null, taxRate?: num|null, parentArticleId?: int|null, parentSku?: str|null, fullHash?: str|null, thumbW?: int|null, thumbH?: int|null, thumbHash?: str|null, brand?: T31|null }[] }` #### List category attribute values — `GET /category/{id}/attributevalue` - Params: `id: int` - Returns: `200 { attributevalues: { id: int, attributeId: int, attributeName: str, attributeValueId: int, value: str, sort: int, categoryId?: int, exclusive?: bool }[] }` @@ -298,7 +296,7 @@ _none_ - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }` #### Create customer group — `POST /customergroup` - Params: `body: { name: str }` -- Returns: `201 { customergroup: T47 }` +- Returns: `201 { customergroup: T45 }` #### Reorder customer groups — `PUT /customergroup/order` - Params: `body: { customergroupIds: int[] }` - Returns: `200 { customergroupIds: int[] }` @@ -307,15 +305,15 @@ _none_ - Returns: `204 void` #### Update customer group — `PATCH /customergroup/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { customergroup: T47 }` +- Returns: `200 { customergroup: T45 }` ### Section: /delivery #### List deliveries — `GET /delivery` _none_ -- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T44 }[] }` +- Returns: `200 { deliveries: { id: int, number: str, type: str, supplierId: int|null, date: str, externalNumber?: str|null, createdAt?: str, ledger?: T42 }[] }` #### Create delivery — `POST /delivery` -- Params: `body: { externalNumber: str, date: str, lines: T29[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `body: { externalNumber: str, date: str, lines: T27[], supplierId?: int|null, files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `201 T9` #### Delete delivery — `DELETE /delivery/{id}` - Params: `id: int` @@ -324,7 +322,7 @@ _none_ - Params: `id: int` - Returns: `200 T9` #### Update delivery — `PATCH /delivery/{id}` -- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T29[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` +- Params: `id: int, body: { externalNumber?: str|null, date?: str, supplierId?: int|null, lines?: T27[], files?: { mimetype: str, name: str, content: str, sort?: int, size?: int, hash?: str, created?: str, modified?: str, meta?: { [k]: str } }[] }` - Returns: `200 T9` #### Delete delivery file attachment — `DELETE /delivery/{id}/file/{fileId}` - Params: `id: int, fileId: int` @@ -337,10 +335,10 @@ _none_ #### List entities — `GET /entity` - Params: `query: customergroupId?: int, role?: str` -- Returns: `200 { entities: T31[] }` +- Returns: `200 { entities: T29[] }` #### Create entity — `POST /entity` - Params: `body: { customergroupId: int, name: str, firstName?: str|null, number?: str }` -- Returns: `201 T23` +- Returns: `201 T22` #### Peek next customer number — `GET /entity/next-number` _none_ - Returns: `200 { number: str }` @@ -358,25 +356,25 @@ _none_ - Returns: `200 { address: T16 }` #### List entity contacts — `GET /entity/{entityId}/contact` - Params: `entityId: int` -- Returns: `200 { contacts: T42[] }` +- Returns: `200 { contacts: T40[] }` #### Create entity contact — `POST /entity/{entityId}/contact` - Params: `entityId: int, body: { contactType: str, contact: str }` -- Returns: `201 { contact: T42 }` +- Returns: `201 { contact: T40 }` #### Delete entity contact — `DELETE /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int` - Returns: `204 void` #### Update entity contact — `PATCH /entity/{entityId}/contact/{id}` - Params: `entityId: int, id: int, body: { contactType?: str, contact?: str }` -- Returns: `200 { contact: T42 }` +- Returns: `200 { contact: T40 }` #### Delete entity — `DELETE /entity/{id}` - Params: `id: int` - Returns: `204 void` #### Get entity — `GET /entity/{id}` - Params: `id: int` -- Returns: `200 T23` +- Returns: `200 T22` #### Update entity — `PATCH /entity/{id}` - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }` -- Returns: `200 T23` +- Returns: `200 T22` ### Section: /labeltemplate @@ -384,7 +382,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: T21 }` +- Params: `body: { name: str, width: num, height: num, dpi: int, type: str, content: T20 }` - Returns: `201 T11` #### Delete label template — `DELETE /labeltemplate/{id}` - Params: `id: int` @@ -393,10 +391,10 @@ _none_ - Params: `id: int` - Returns: `200 T11` #### Update label template (partial) — `PATCH /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T21 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T20 }` - Returns: `200 T11` #### Update label template — `PUT /labeltemplate/{id}` -- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T21 }` +- Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T20 }` - Returns: `200 T11` ### Section: /ledger @@ -429,7 +427,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, onlyUnpaid?: bool, onlyUndelivered?: bool, seekMonths?: int` - Returns: `200 { orders: T2[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create order — `POST /order` -- Params: `body: { number: str, date: str, lines: T29[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T27[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T1` #### Delete order — `DELETE /order/{id}` - Params: `id: int` @@ -438,17 +436,17 @@ _none_ - Params: `id: int` - Returns: `200 T1` #### Update order — `PATCH /order/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T27[] }` - Returns: `200 T1` #### Delete order file attachment — `DELETE /order/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### List payments of an order — `GET /order/{id}/payment` - Params: `id: int` -- Returns: `200 { payments: T38[] }` +- Returns: `200 { payments: T36[] }` #### Add payment to an order — `POST /order/{id}/payment` - Params: `id: int, body: { accountId: int, type: str, amount: num }` -- Returns: `201 { payment: T38 }` +- Returns: `201 { payment: T36 }` #### Generate and attach order PDF — `POST /order/{id}/pdf` - Params: `id: int` - Returns: `201 T12` @@ -460,10 +458,10 @@ _none_ - Returns: `201 T5` #### List shippings of an order — `GET /order/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T32[] }` +- Returns: `200 { shippings: T30[] }` #### Create shipping for an order — `POST /order/{id}/shipping` - Params: `id: int, body: { type: str, state: str, warehouseId?: int }` -- Returns: `201 T27` +- Returns: `201 T25` ### Section: /package @@ -481,10 +479,10 @@ _none_ #### List printers — `GET /printer` _none_ -- Returns: `200 { printers: T28[] }` +- Returns: `200 { printers: T26[] }` #### Create printer — `POST /printer` - Params: `body: { address: str, type: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `201 T22` +- Returns: `201 T21` #### Reorder printers — `PUT /printer/order` - Params: `body: { printerIds: int[] }` - Returns: `200 { printerIds: int[] }` @@ -493,22 +491,22 @@ _none_ - Returns: `204 void` #### Get printer by ID — `GET /printer/{id}` - Params: `id: int` -- Returns: `200 T22` +- Returns: `200 T21` #### Update printer (partial) — `PATCH /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `200 T22` +- Returns: `200 T21` #### Update printer — `PUT /printer/{id}` - Params: `id: int, body: { address?: str, type?: str, model?: str|null, serial?: str|null, sort?: int, desc?: str|null }` -- Returns: `200 T22` +- Returns: `200 T21` ### Section: /propertyname #### List property names — `GET /propertyname` _none_ -- Returns: `200 { propertynames: T37[] }` +- Returns: `200 { propertynames: T35[] }` #### Create property name — `POST /propertyname` - Params: `body: { name: str, sort?: int, exclusive?: bool }` -- Returns: `201 { propertyname: T37 }` +- Returns: `201 { propertyname: T35 }` #### Reorder property names — `PUT /propertyname/order` - Params: `body: { propertynameIds: int[] }` - Returns: `200 { ok: bool }` @@ -517,7 +515,7 @@ _none_ - Returns: `200 { ok: bool }` #### Update property name — `PATCH /propertyname/{id}` - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }` -- Returns: `200 { propertyname: T37 }` +- Returns: `200 { propertyname: T35 }` ### Section: /quote @@ -525,7 +523,7 @@ _none_ - Params: `query: offset?: int, limit?: int, search?: str, seekMonths?: int` - Returns: `200 { quotes: T8[], total: int, unfilteredTotal: int, offset: int, limit: int }` #### Create quote — `POST /quote` -- Params: `body: { number: str, date: str, lines: T29[], entityId?: int|null, externalNumber?: str|null }` +- Params: `body: { number: str, date: str, lines: T27[], entityId?: int|null, externalNumber?: str|null }` - Returns: `201 T7` #### Delete quote — `DELETE /quote/{id}` - Params: `id: int` @@ -534,13 +532,13 @@ _none_ - Params: `id: int` - Returns: `200 T7` #### Update quote — `PATCH /quote/{id}` -- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` +- Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, externalNumber?: str|null, lines?: T27[] }` - Returns: `200 T7` #### Delete quote file attachment — `DELETE /quote/{id}/file/{fileId}` - Params: `id: int, fileId: int` - Returns: `204 void` #### Create order from quote — `POST /quote/{id}/order` -- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T29[] }` +- Params: `id: int, body?: { number?: str, date?: str, createdAt?: str, entityId?: int|null, externalNumber?: str|null, lines?: T27[] }` - Returns: `201 T1` #### Generate and attach quote PDF — `POST /quote/{id}/pdf` - Params: `id: int` @@ -568,10 +566,10 @@ _none_ - Returns: `201 T12` #### List packages of a shipment — `GET /shipment/{id}/shipping` - Params: `id: int` -- Returns: `200 { shippings: T32[] }` +- Returns: `200 { shippings: T30[] }` #### Create package for a shipment — `POST /shipment/{id}/shipping` - Params: `id: int, body: { type: str, state: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `201 T27` +- Returns: `201 T25` ### Section: /shipping @@ -580,7 +578,7 @@ _none_ - Returns: `204 void` #### Update shipping — `PATCH /shipping/{id}` - Params: `id: int, body: { type?: str, state?: str, trackingCode?: str, carrier?: str, warehouseId?: int }` -- Returns: `200 T27` +- Returns: `200 T25` #### List packages of a shipping — `GET /shipping/{id}/package` - Params: `id: int` - Returns: `200 { packages: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null }[] }` @@ -604,22 +602,22 @@ _none_ #### List suppliers — `GET /supplier` _none_ -- Returns: `200 { suppliers: T43[] }` +- Returns: `200 { suppliers: T41[] }` #### Create supplier — `POST /supplier` - Params: `body: { name: str }` -- Returns: `201 { supplier: T43 }` +- Returns: `201 { supplier: T41 }` #### Delete supplier — `DELETE /supplier/{id}` - Params: `id: int` - Returns: `204 void` #### Update supplier — `PATCH /supplier/{id}` - Params: `id: int, body: { name: str }` -- Returns: `200 { supplier: T43 }` +- Returns: `200 { supplier: T41 }` #### List supplier articles by SKUs — `GET /supplier/{id}/articles` -- Params: `id: int, query: skus?: string` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T46|null }[] }` +- 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?: T44|null }[] }` #### Query supplier articles by SKUs (bulk) — `POST /supplier/{id}/articles` - Params: `id: int, body?: { skus?: str[] }` -- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T46|null }[] }` +- Returns: `200 { articles: { id: int, articleId: int, entityId: int, pu: num, sort: int, article: { id: int, sku: str, name?: str|null, slug?: str|null, photos?: { sort: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str }[], eans?: str[] }, supplierName?: str|null, sku?: str|null, stock?: num|null, priceId?: int|null, price?: T44|null }[] }` ### Section: /unit @@ -628,19 +626,19 @@ _none_ - Returns: `204 void` #### List units — `GET /unit` _none_ -- Returns: `200 { units: T35[] }` +- Returns: `200 { units: T33[] }` #### Upsert unit — `PUT /unit` - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }` -- Returns: `200 { unit: T35 }` +- Returns: `200 { unit: T33 }` ### Section: /warehouse #### List warehouses — `GET /warehouse` _none_ -- Returns: `200 { warehouses: T47[] }` +- Returns: `200 { warehouses: T45[] }` #### Create warehouse — `POST /warehouse` - Params: `body: { name: str, sort?: int }` -- Returns: `201 T45` +- Returns: `201 T43` #### Reorder warehouses — `PUT /warehouse/order` - Params: `body: { warehouseIds: int[] }` - Returns: `200 { warehouseIds: int[] }` @@ -649,13 +647,13 @@ _none_ - Returns: `204 void` #### Get warehouse by ID — `GET /warehouse/{id}` - Params: `id: int` -- Returns: `200 T45` +- Returns: `200 T43` #### Update warehouse (partial) — `PATCH /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T45` +- Returns: `200 T43` #### Update warehouse — `PUT /warehouse/{id}` - Params: `id: int, body: { name?: str, sort?: int }` -- Returns: `200 T45` +- Returns: `200 T43` ### Binary & streaming routes (reachable only via `fetch()` in javascript_execute) These routes are NOT in the table above because their responses are binary or long-lived streams, which the `dashback_request` tool cannot return usefully. They ARE reachable from inside `javascript_execute` with `fetch("/route")`, where you can decode the bytes, write them to the VFS and embed them in your reply: diff --git a/docs/api/routes/modelconversation.get.md b/docs/api/routes/modelconversation.get.md index 06266ad..df3d50b 100644 --- a/docs/api/routes/modelconversation.get.md +++ b/docs/api/routes/modelconversation.get.md @@ -21,7 +21,7 @@ List of conversations "created_at": "…", "updated_at": "…", "state": "idle", - "started_by": "…", + "started_by": 1, "first_message": "…" } ] diff --git a/docs/api/routes/modelconversation.post.md b/docs/api/routes/modelconversation.post.md index 9ab38eb..75adcb2 100644 --- a/docs/api/routes/modelconversation.post.md +++ b/docs/api/routes/modelconversation.post.md @@ -38,7 +38,7 @@ Created conversation "created_at": "…", "updated_at": "…", "state": "idle", - "started_by": "…", + "started_by": 1, "first_message": "…" } } diff --git a/docs/api/routes/modelconversation/_id.get.md b/docs/api/routes/modelconversation/_id.get.md index 2869d42..74b484f 100644 --- a/docs/api/routes/modelconversation/_id.get.md +++ b/docs/api/routes/modelconversation/_id.get.md @@ -26,7 +26,7 @@ Conversation details "created_at": "…", "updated_at": "…", "state": "idle", - "started_by": "…", + "started_by": 1, "first_message": "…" } } diff --git a/docs/api/routes/public/_companyId/articles/_sku.md b/docs/api/routes/public/_companyId/articles/_sku.md index 94d8da9..68f0f57 100644 --- a/docs/api/routes/public/_companyId/articles/_sku.md +++ b/docs/api/routes/public/_companyId/articles/_sku.md @@ -28,17 +28,53 @@ Article detail "unitamount": 1, "weight": 1, "trackStock": true, - "unit": {}, - "brand": {}, - "price": {}, + "unit": { + "si": "…", + "basesi": "…", + "basesifactor": 1, + "symbol": "…", + "name": "…" + }, + "brand": { + "id": 1, + "name": "…", + "fullHash": "…", + "thumbW": 1, + "thumbH": 1, + "thumbHash": "…" + }, + "price": { + "minmultiplier": 1, + "net": 1, + "taxRate": 1, + "gross": 1 + }, "prices": [ - {} + { + "minmultiplier": 1, + "net": 1, + "taxRate": 1, + "gross": 1 + } ], "categories": [ - {} + { + "id": 1, + "name": "…", + "slug": "…" + } ], "photos": [ - {} + { + "sort": 1, + "fullHash": "…", + "fullW": 1, + "fullH": 1, + "fullSize": 1, + "thumbW": 1, + "thumbH": 1, + "thumbHash": "…" + } ], "eans": [ "…" @@ -46,7 +82,18 @@ Article detail "isParent": true, "parentSku": "…", "variants": [ - {} + { + "id": 1, + "sku": "…", + "sort": 1, + "name": "…", + "slug": "…", + "attributeValueId": 1, + "attributeValue": "…", + "unitamount": 1, + "weight": 1, + "trackStock": true + } ] } } diff --git a/docs/api/routes/supplier/articles.get.md b/docs/api/routes/supplier/articles.get.md index 1624135..03ca0b8 100644 --- a/docs/api/routes/supplier/articles.get.md +++ b/docs/api/routes/supplier/articles.get.md @@ -19,7 +19,7 @@ Includes linked article details (name, slug, photos, eans). | Param | Required | Type | Description | |-------|----------|------|-------------| -| `skus` | no | | Optional SKU or comma-separated SKUs to filter by | +| `skus` | no | string | Optional SKU or comma-separated SKUs to filter by | ## Response `200` diff --git a/scripts/generateApiDocs.js b/scripts/generateApiDocs.js index 6b28d49..5d40fd3 100644 --- a/scripts/generateApiDocs.js +++ b/scripts/generateApiDocs.js @@ -560,6 +560,16 @@ function summarizeSchema( if (!resolved) return schemaRefName(schema) || ''; if (resolved.$ref) return schemaRefName(resolved) || ''; + const union = resolved.oneOf || resolved.anyOf; + if (Array.isArray(union) && union.length) { + const parts = union + .map((s) => summarizeSchema(s, components, depth + 1, markOptional, aliases)) + .filter(Boolean); + if (parts.length) { + return [...new Set(parts)].join('|'); + } + } + if (resolved.type === 'array') { const item = summarizeSchema(resolved.items, components, depth + 1, markOptional, aliases) || 'any'; return `${item}[]`; @@ -567,7 +577,7 @@ function summarizeSchema( if (resolved.type === 'object' || resolved.properties) { const shape = aliases && summarizeSchema(resolved, components, 0, markOptional); - const alias = shape && aliases.get(`${markOptional ? 1 : 0}\0${shape}`); + const alias = shape && aliases.get(shape); if (alias && !skipRootAlias) return alias; const hasExplicitRequired = Array.isArray(resolved.required); @@ -602,6 +612,22 @@ function summarizeSchema( } if (resolved.type) { + if (Array.isArray(resolved.type)) { + const types = resolved.type.map((raw) => { + if (raw === 'null') return 'null'; + if (aliases?.compactTypes) { + return { + string: 'str', + integer: 'int', + number: 'num', + boolean: 'bool', + object: '{}', + }[raw] || raw; + } + return raw; + }); + return types.join('|'); + } let t = resolved.type; if (aliases?.compactTypes) { t = { @@ -633,12 +659,11 @@ function collectSchemaAliases(operations) { if (resolved.type !== 'object' && !resolved.properties) return; const shape = summarizeSchema(resolved, spec.components, 0, markOptional); - const key = `${markOptional ? 1 : 0}\0${shape}`; - const current = shapes.get(key); + const current = shapes.get(shape); if (current) { current.count += 1; } else { - shapes.set(key, { count: 1, shape, schema: resolved, markOptional }); + shapes.set(shape, { count: 1, shape, schema: resolved, markOptional }); } for (const prop of Object.values(resolved.properties || {})) { visit(prop, markOptional); @@ -664,9 +689,9 @@ function collectSchemaAliases(operations) { .sort((a, b) => b[1].shape.length - a[1].shape.length || a[0].localeCompare(b[0])); const aliases = new Map(); const definitions = []; - for (const [key, item] of candidates) { + for (const [, item] of candidates) { const alias = `T${definitions.length + 1}`; - aliases.set(key, alias); + aliases.set(item.shape, alias); definitions.push({ alias, ...item }); } aliases.compactTypes = true; @@ -680,7 +705,7 @@ function collectSchemaAliases(operations) { * @returns {string} */ function paramType(param, aliases = null) { - return summarizeSchema(param?.schema, spec.components, 0, false, aliases) || 'string'; + return summarizeSchema(param?.schema, spec.components, 0, false, aliases) || (aliases?.compactTypes ? 'str' : 'string'); } function summarizeOperationParams(operation, aliases = null) { diff --git a/src/api/openapi.js b/src/api/openapi.js index 809c38d..36cb2ac 100644 --- a/src/api/openapi.js +++ b/src/api/openapi.js @@ -1176,10 +1176,12 @@ * enum: [idle, busy] * description: Messages can only be posted while `idle` * started_by: - * type: [integer, 'null'] + * type: integer + * nullable: true * description: Id of the conversation that started this one as a subagent, or null for a top-level conversation. Deleting a conversation also deletes every conversation below it in this chain. * first_message: - * type: [string, 'null'] + * type: string + * nullable: true * description: Plain text of the conversation's first user message (XML stripped, max 50 chars, ellipsis if cut), or null if there is none yet. * ModelConversationCreateInput: * type: object diff --git a/src/api/routes/publicCatalog.js b/src/api/routes/publicCatalog.js index 94d0fa8..776fc8b 100644 --- a/src/api/routes/publicCatalog.js +++ b/src/api/routes/publicCatalog.js @@ -306,26 +306,57 @@ export function register(app, basePath = '') { * trackStock: * type: boolean * unit: - * type: object + * $ref: '#/components/schemas/Unit' * nullable: true * brand: - * type: object + * $ref: '#/components/schemas/ArticleBrand' * nullable: true * price: * type: object * nullable: true + * properties: + * minmultiplier: + * type: number + * net: + * type: number + * nullable: true + * taxRate: + * type: number + * nullable: true + * gross: + * type: number + * nullable: true * prices: * type: array * items: * type: object + * properties: + * minmultiplier: + * type: number + * net: + * type: number + * nullable: true + * taxRate: + * type: number + * nullable: true + * gross: + * type: number + * nullable: true * categories: * type: array * items: * type: object + * properties: + * id: + * type: integer + * name: + * type: string + * slug: + * type: string * photos: * type: array * items: - * type: object + * $ref: '#/components/schemas/ArticlePhoto' * eans: * type: array * items: @@ -339,6 +370,31 @@ export function register(app, basePath = '') { * type: array * items: * type: object + * properties: + * id: + * type: integer + * sku: + * type: string + * sort: + * type: integer + * name: + * type: string + * slug: + * type: string + * attributeValueId: + * type: integer + * nullable: true + * attributeValue: + * type: string + * nullable: true + * unitamount: + * type: number + * nullable: true + * weight: + * type: number + * nullable: true + * trackStock: + * type: boolean * 400: * description: Invalid parameters * content: diff --git a/src/api/routes/supplier.js b/src/api/routes/supplier.js index b7d802a..ba6bb8f 100644 --- a/src/api/routes/supplier.js +++ b/src/api/routes/supplier.js @@ -384,11 +384,7 @@ export function register(app, basePath = '') { * name: skus * required: false * schema: - * oneOf: - * - type: array - * items: - * type: string - * - type: string + * type: string * description: Optional SKU or comma-separated SKUs to filter by * responses: * 200: