seb/dashback
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

u

Browse Source
This commit is contained in:
seb
2026-10-04 21:22:00 +02:00
parent 6777f423d8
commit 45369d11da
16 changed files with 133 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/api/routes.md
View File

@@ -44,24 +44,21 @@ Overview of all 145 API endpoints across all modules.
#### Replace article categories by SKU — `PUT /article/{sku}/categories`
- Params: `sku: string, body: { categoryIds: integer[] }`
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
#### List child articles of a father article — `GET /article/{sku}/children`
#### List child articles of a parent article — `GET /article/{sku}/children`
- Params: `sku: string`
- Returns: `200 { children: { id: integer, sku: string, name: string, fathersort: integer, attributeValueId: integer, attributeValue: string }[] }`
#### Create and attach a new child article to a father article — `POST /article/{sku}/children`
- Returns: `200 { children: { id: integer, sku: string, name: string, parentsort: integer, attributeValueId: integer, attributeValue: string }[] }`
#### Create and attach a new child article to a parent article — `POST /article/{sku}/children`
- Params: `sku: string, body: { attributeValueId?: integer, value?: string, name?: string }`
- Returns: `201 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean } }`
#### Attach an existing article as a child to a father article — `PUT /article/{sku}/children`
#### Attach an existing article as a child to a parent article — `PUT /article/{sku}/children`
- Params: `sku: string, body: { sku: string, attributeValueId?: integer, value?: string, reparent?: boolean }`
- Returns: `200 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean }, children: object[] }`
#### Remove a child article from a father article — `DELETE /article/{sku}/children/{childSku}`
#### Remove a child article from a parent article — `DELETE /article/{sku}/children/{childSku}`
- Params: `sku: string, childSku: string, query: deleteArticle?: boolean`
- Returns: `200 { success: boolean, deleted: boolean }`
#### Replace article EANs by SKU — `PUT /article/{sku}/eans`
- Params: `sku: string, body: { eans: string[] }`
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`
#### Toggle father mode for an article — `POST /article/{sku}/father`
- Params: `sku: string, body: { isFather: boolean, attributeNameId?: integer }`
- Returns: `200 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean } }`
#### Get article history by SKU — `GET /article/{sku}/history`
- Params: `sku: string, query: limit?: integer`
- Returns: `200 { history: { id: integer, date: string, text: string }[], truncated: boolean }`
@@ -77,6 +74,9 @@ Overview of all 145 API endpoints across all modules.
#### Set options list for an article — `PUT /article/{sku}/optionslist`
- Params: `sku: string, body: { options: { articleId?: integer, sku?: string, count?: integer, sort?: integer, mandated?: boolean }[] }`
- Returns: `200 { options: object[] }`
#### Toggle parent mode for an article — `POST /article/{sku}/parent`
- Params: `sku: string, body: { isParent: boolean, attributeNameId?: integer }`
- Returns: `200 { article: { id: integer, categoryId: integer, name: string, sku: string, track_stock: boolean } }`
#### Replace POS prices by SKU — `PUT /article/{sku}/prices`
- Params: `sku: string, body: { prices: { price: number, tax: number, minmultiplier?: number }[] }`
- Returns: `200 { article: { id: integer, sku: string, name: string, slug: string, track_stock: boolean, unitamount: number, weight: number, unit: object, brand: object, categoryIds: integer[], photos: { sort: integer, fullHash: string, fullW: integer, fullH: integer, fullSize: integer, thumbW: integer, thumbH: integer, thumbHash: string }[], eans: string[], prices: { minmultiplier: number, net: number, taxRate: number, customergroupId: integer }[], suppliers: { id: integer, articleId: integer, entityId: integer, supplierName: string, sku: string, pu: number, stock: number, sort: integer, priceId: integer, price: { net: number, taxId: integer, taxRate: number } }[] } }`