Files
dashback/docs/api/routes/article/update.md
2026-10-19 02:28:17 +02:00

2.7 KiB

PATCH /article/{sku}

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

Update article by SKU

Patches article fields. At least one of name, unitamount, unitSi required. unitSi must already exist for the company. Returns the same detail shape as GET.

Path parameters

Param Required Type Description
sku yes string Article SKU

Body (JSON)

Field Required Type Description
name no string
desc no string Article description text/HTML
seo no string SEO text
unitamount no number Must be finite and > 0
unitSi no string Existing company unit si
track_stock no boolean Whether to track inventory stock
{
  "unitamount": 0.24,
  "unitSi": "l"
}

Signals

On success, emits SSE signal: articles (see GET /events).

Response 200

Updated article detail

{
  "article": {
    "id": 1,
    "sku": "…",
    "name": "…",
    "slug": "…",
    "desc": "…",
    "seo": "…",
    "track_stock": true,
    "unitamount": 1,
    "weight": 1,
    "unit": {
      "si": "…",
      "basesi": "…",
      "basesifactor": 1,
      "symbol": "…",
      "name": "…"
    },
    "brand": {
      "id": 1,
      "name": "…",
      "fullHash": "…",
      "thumbW": 1,
      "thumbH": 1,
      "thumbHash": "…"
    },
    "categoryIds": [
      1
    ],
    "photos": [
      {
        "sort": 1,
        "fullHash": "…",
        "fullW": 1,
        "fullH": 1,
        "fullSize": 1,
        "thumbW": 1,
        "thumbH": 1,
        "thumbHash": "…"
      }
    ],
    "eans": [
      "…"
    ],
    "prices": [
      {
        "minmultiplier": 1,
        "net": 1,
        "taxRate": 1,
        "customergroupId": 1
      }
    ],
    "suppliers": [
      {
        "id": 1,
        "articleId": 1,
        "entityId": 1,
        "supplierName": "…",
        "sku": "…",
        "pu": 1,
        "stock": 1,
        "sort": 1,
        "priceId": 1,
        "price": {
          "net": 1,
          "taxId": 1,
          "taxRate": 1
        },
        "incoming": [
          {
            "date": "2026-08-10T00:00:00.000Z",
            "amount": 1
          }
        ]
      }
    ]
  }
}

Errors

Status Description
400 Validation error (Name required / Invalid unitamount) — {"error":"…"}
401 Unauthorized — {"error":"…"}
403 Not authorized — {"error":"…"}
404 Article or unit not found — {"error":"…"}

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