u

docs/api/routes.md

@@ -52,6 +52,9 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
 
 ### Routes
 
+
+### Section: /account
+
 #### List accounts — `GET /account`
 _none_
 - Returns: `200 { accounts: { id: int, companyId: int, type: str, name: str }[] }`
@@ -61,6 +64,9 @@ _none_
 #### Delete account — `DELETE /account/{id}`
 - Params: `id: int`
 - Returns: `204 void`
+
+### Section: /article
+
 #### Create article in category — `POST /article`
 - Params: `body: { categoryId: int, name: str, desc?: str, seo?: str, track_stock?: bool }`
 - Returns: `201 T28`
@@ -160,6 +166,9 @@ _none_
 #### Set article weight by SKU — `PUT /article/{sku}/weight`
 - Params: `sku: str, body: { weight: num }`
 - Returns: `200 T1`
+
+### Section: /attributename
+
 #### List attribute names — `GET /attributename`
 _none_
 - Returns: `200 { attributenames: T23[] }`
@@ -184,18 +193,27 @@ _none_
 #### Update attribute name — `PATCH /attributename/{id}`
 - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
 - Returns: `200 { attributename: T23 }`
+
+### Section: /attributevalue
+
 #### Delete attribute value — `DELETE /attributevalue/{id}`
 - Params: `id: int`
 - Returns: `200 { ok: bool }`
 #### Update attribute value — `PATCH /attributevalue/{id}`
 - Params: `id: int, body: { value?: str, sort?: int }`
 - Returns: `200 { attributevalue: T34 }`
+
+### Section: /auth
+
 #### Login with Google ID token — `POST /auth/login`
 - Params: `body: { idToken: str }`
 - Returns: `200 { message: str, user: { id: int, email: str, selectedCompanyId: int|null, picture?: str } }`
 #### Logout — `POST /auth/logout`
 _none_
 - Returns: `200 { message: str }`
+
+### Section: /brand
+
 #### List brands — `GET /brand`
 - Params: `query: offset?: int, limit?: int, includeSmallThumbs?: bool`
 - Returns: `200 { brands: { id: int, name: str, 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 }`
@@ -214,6 +232,9 @@ _none_
 #### Add or replace brand image — `POST /brand/{id}/image`
 - Params: `id: int, image/avif`
 - Returns: `201 { brand: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T32[] } }`
+
+### Section: /category
+
 #### Create category — `POST /category`
 - Params: `body: { parentId: int, name: str }`
 - Returns: `201 { category: { id: int, parentId: int|null, sort: int, name: str } }`
@@ -250,6 +271,9 @@ _none_
 #### Delete category property — `DELETE /category/{id}/property/{propertyId}`
 - Params: `id: int, propertyId: int`
 - Returns: `200 { ok: bool }`
+
+### Section: /company
+
 #### List companies — `GET /company`
 _none_
 - Returns: `200 { companies: { id: int, iso639: str, name: str, taxrate: num, reducedtaxrate: num }[] }`
@@ -274,6 +298,9 @@ _none_
 #### Update company — `PUT /company/{id}`
 - Params: `id: int, body: { iso639: str, name: str, taxrate: num, reducedtaxrate: num }`
 - Returns: `200 { company: { id: int, iso639: str, name: str, taxrate: num, reducedtaxrate: num } }`
+
+### Section: /customergroup
+
 #### List customer groups — `GET /customergroup`
 _none_
 - Returns: `200 { customergroups: { id: int, name: str, sort: int, editable: bool }[] }`
@@ -289,6 +316,9 @@ _none_
 #### Update customer group — `PATCH /customergroup/{id}`
 - Params: `id: int, body: { name: str }`
 - Returns: `200 { customergroup: T40 }`
+
+### 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?: T36 }[] }`
@@ -307,6 +337,9 @@ _none_
 #### Get delivery attachment file content — `GET /delivery/{id}/file/{fileId}`
 - Params: `id: int, fileId: int, query: download?: bool`
 - Returns: `200 str`
+
+### Section: /entity
+
 #### List entities — `GET /entity`
 - Params: `query: customergroupId?: int, role?: str`
 - Returns: `200 { entities: T26[] }`
@@ -349,6 +382,9 @@ _none_
 #### Update entity — `PATCH /entity/{id}`
 - Params: `id: int, body: { name?: str, firstName?: str|null, number?: str|null }`
 - Returns: `200 T18`
+
+### Section: /labeltemplate
+
 #### List label templates — `GET /labeltemplate`
 _none_
 - Returns: `200 { labeltemplates: { id: int, name: str, width: num, height: num, dpi: int, type: str, thumb?: str|null }[] }`
@@ -367,6 +403,9 @@ _none_
 #### Update label template — `PUT /labeltemplate/{id}`
 - Params: `id: int, body: { name?: str, width?: num, height?: num, dpi?: int, type?: str, content?: T16 }`
 - Returns: `200 T5`
+
+### Section: /ledger
+
 #### Query ledger by manifest article ID or SKU — `GET /ledger`
 - Params: `query: manifestarticle_id?: int, sku?: str, transaction_type?: str`
 - Returns: `200 T13`
@@ -379,12 +418,18 @@ _none_
 #### Query ledger by article SKU — `GET /ledger/sku/{sku}`
 - Params: `sku: str, query: transaction_type?: str`
 - Returns: `200 T13`
+
+### Section: /number
+
 #### List number sequences — `GET /number`
 _none_
 - Returns: `200 { numbers: { id: int, type: str, prefix: str, padding: int, next: int }[] }`
 #### Update number sequence — `PATCH /number/{id}`
 - Params: `id: int, body: { prefix?: str, padding?: int, next?: int }`
 - Returns: `200 { number: { id: int, type: str, prefix: str, padding: int, next: int } }`
+
+### Section: /order
+
 #### List orders — `GET /order`
 - Params: `query: offset?: int, limit?: int`
 - Returns: `200 { orders: T10[], total: int, offset: int, limit: int }`
@@ -412,12 +457,21 @@ _none_
 #### Create shipping for an order — `POST /order/{id}/shipping`
 - Params: `id: int, body: { type: str, state: str }`
 - Returns: `201 { shipping: { id: int, manifestId: int, number: str, type: str, state: str } }`
+
+### Section: /package
+
 #### Delete package — `DELETE /package/{id}`
 - Params: `id: int`
 - Returns: `204 void`
+
+### Section: /payment
+
 #### Delete payment — `DELETE /payment/{id}`
 - Params: `id: int`
 - Returns: `204 void`
+
+### Section: /printer
+
 #### List printers — `GET /printer`
 _none_
 - Returns: `200 { printers: T22[] }`
@@ -439,6 +493,9 @@ _none_
 #### 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 T17`
+
+### Section: /propertyname
+
 #### List property names — `GET /propertyname`
 _none_
 - Returns: `200 { propertynames: T37[] }`
@@ -454,6 +511,9 @@ _none_
 #### Update property name — `PATCH /propertyname/{id}`
 - Params: `id: int, body: { name?: str, sort?: int, exclusive?: bool }`
 - Returns: `200 { propertyname: T37 }`
+
+### Section: /quote
+
 #### List quotes — `GET /quote`
 _none_
 - Returns: `200 { quotes: { id: int, number: str, type: str, entityId: int|null, date: str, createdAt?: str }[] }`
@@ -469,6 +529,9 @@ _none_
 #### Update quote — `PATCH /quote/{id}`
 - Params: `id: int, body: { number?: str, date?: str, entityId?: int|null, lines?: T24[] }`
 - Returns: `200 T8`
+
+### Section: /shipping
+
 #### Delete shipping — `DELETE /shipping/{id}`
 - Params: `id: int`
 - Returns: `204 void`
@@ -478,12 +541,21 @@ _none_
 #### Create package for a shipping — `POST /shipping/{id}/package`
 - Params: `id: int, body: { entityaddressId: int, type: str, state: str, details?: str }`
 - Returns: `201 { package: { id: int, shippingId: int, entityaddressId: int, number: str, type: str, state: str, details?: str|null } }`
+
+### Section: /smallthumb
+
 #### Small thumb image by hash — `GET /smallthumb/{fullHash}`
 - Params: `fullHash: str`
 - Returns: `200 avif`
+
+### Section: /stock
+
 #### Adjust stock manually — `POST /stock/adjust`
 - Params: `body: { sku?: str, warehouseId?: int, amount?: num, text?: str|null, lines?: { sku: str, amount: num, warehouseId?: int, text?: str }[] }`
 - Returns: `201 { manifest: { id: int, number: str, type: str, date: str, createdAt: str }, lines: { manifestarticle_id: int, sku: str, name: str, warehouse_id: int, amount: num, text: str }[], ledger: T14[] }`
+
+### Section: /supplier
+
 #### List suppliers — `GET /supplier`
 _none_
 - Returns: `200 { suppliers: T35[] }`
@@ -502,6 +574,9 @@ _none_
 #### 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?: T39|null }[] }`
+
+### Section: /unit
+
 #### Delete unit — `DELETE /unit`
 - Params: `query: si: str`
 - Returns: `204 void`
@@ -511,6 +586,9 @@ _none_
 #### Upsert unit — `PUT /unit`
 - Params: `body: { si: str, basesi: str, basesifactor: num, symbol: str, name: str }`
 - Returns: `200 { unit: T29 }`
+
+### Section: /warehouse
+
 #### List warehouses — `GET /warehouse`
 _none_
 - Returns: `200 { warehouses: T40[] }`