Files
dashback/docs/api/routes/category/articles.md
2026-10-30 06:43:45 +01:00

2.1 KiB

GET /category/{id}/articles

Protected. Requires a valid session cookie (credentials: 'include').

Articles in category

Returns articles in a category the user is authorized for, sorted alphabetically by name. By default includes child articles (variants); pass includeChildren=false to omit them. Each article includes childCount (the number of its child articles) and small thumbnail fields (smallThumbW, smallThumbH, smallThumbBinary).

Path parameters

Param Required Type Description
id yes integer Category id

Query parameters

Param Required Type Description
includeChildren no boolean When true (default), includes child articles (variants) alongside parent articles. Set to false to omit child articles.

Response 200

Articles list

{
  "articles": [
    {
      "id": 1,
      "sku": "…",
      "name": "…",
      "slug": "…",
      "net": 1,
      "taxRate": 1,
      "track_stock": true,
      "optionsCount": 1,
      "articleListCount": 1,
      "childCount": 1,
      "parentArticleId": 1,
      "parentSku": "…",
      "fullHash": "…",
      "thumbW": 1,
      "thumbH": 1,
      "thumbHash": "…",
      "smallThumbW": 1,
      "smallThumbH": 1,
      "smallThumbBinary": "…",
      "brand": {
        "id": 1,
        "name": "…",
        "fullHash": "…",
        "thumbW": 1,
        "thumbH": 1,
        "thumbHash": "…"
      },
      "articlewarehousesummary": [
        {
          "id": 1,
          "articleId": 1,
          "article_id": 1,
          "warehouseId": 1,
          "warehouse_id": 1,
          "warehouseName": "…",
          "stock": 1
        }
      ],
      "warehouses": [
        {
          "id": 1,
          "name": "…",
          "stock": 1
        }
      ]
    }
  ]
}

Errors

Status Description
400 Invalid id — {"error":"…"}
401 Unauthorized — {"error":"…"}
403 Not authorized — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.