80 lines
1.3 KiB
Markdown
80 lines
1.3 KiB
Markdown
# `PUT /article/{sku}/weight`
|
|
|
|
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
|
|
Set article weight by SKU
|
|
|
|
Sets the article's `weight`. Must be finite and `>= 0`.
|
|
Returns the same shape as GET by SKU.
|
|
|
|
|
|
## Path parameters
|
|
|
|
| Param | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `sku` | yes | string | |
|
|
|
|
## Body (JSON)
|
|
|
|
| Field | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `weight` | yes | number | |
|
|
|
|
```json
|
|
{
|
|
"weight": 1.5
|
|
}
|
|
```
|
|
|
|
## 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 | Invalid weight — `{"error":"…"}` |
|
|
| 401 | Unauthorized — `{"error":"…"}` |
|
|
| 403 | Not authorized — `{"error":"…"}` |
|
|
| 404 | Article not found — `{"error":"…"}` |
|
|
|
|
---
|
|
|
|
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|