57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# `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 |
|
|
|
|
```json
|
|
{
|
|
"unitamount": 0.24,
|
|
"unitSi": "l"
|
|
}
|
|
```
|
|
|
|
## Signals
|
|
|
|
On success, emits SSE signal: `articles` (see [`GET /events`](../events.md)).
|
|
|
|
## Response `204`
|
|
|
|
Updated
|
|
|
|
_No content_
|
|
|
|
## 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`._
|