Files
dashback/docs/api/routes/article/set-brand.md
2026-09-30 19:29:13 +02:00

80 lines
1.4 KiB
Markdown

# `PUT /article/{sku}/brand`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Set or clear article brand by SKU
Sets the article's `brandId` (must belong to the article's company).
Pass `null` to clear the brand. Returns the same shape as GET by SKU.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `sku` | yes | string | |
## Body (JSON)
| Field | Required | Type | Description |
|-------|----------|------|-------------|
| `brandId` | yes | integer | |
```json
{
"brandId": 3
}
```
## Signals
On success, emits SSE signal: `article-<sku>` (see [`GET /events`](../events.md)).
## Response `200`
Updated article detail
```json
{
"article": {
"id": 1,
"sku": "…",
"name": "…",
"slug": "…",
"track_stock": true,
"unitamount": 1,
"weight": 1,
"unit": {},
"brand": {},
"categoryIds": [
1
],
"photos": [
{}
],
"eans": [
"…"
],
"prices": [
{}
],
"suppliers": [
{}
]
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Validation error — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Article or brand not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._