Files
dashback/docs/api/routes/order/update.md
2026-10-12 03:10:35 +02:00

110 lines
2.2 KiB
Markdown

# `PATCH /order/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Update order
Patches header fields that are present. If `lines` is present, replaces
all lines; if omitted, leaves lines unchanged. Returns the full order.
`date` is the document date (expected delivery).
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | |
## Body (JSON)
| Field | Required | Type | Description |
|-------|----------|------|-------------|
| `number` | no | string | |
| `date` | no | string | Document date / expected delivery |
| `entityId` | no | integer | |
| `lines` | no | ManifestLineInput[] | |
```json
{
"number": "O-2026-001b",
"lines": []
}
```
## Response `200`
Updated order
```json
{
"order": {
"id": 1,
"number": "…",
"type": "order",
"entityId": 1,
"date": "2026-08-10T00:00:00.000Z",
"createdAt": "2026-08-10T00:00:00.000Z",
"lines": [
{
"id": 1,
"sku": "…",
"name": "…",
"pu": 1,
"amount": 1,
"net": 1,
"rebate": 1,
"taxrate": 1,
"comment": "…"
}
],
"shipping": {
"id": 1,
"manifestId": 1,
"number": "…",
"type": "…",
"state": "…"
},
"shippings": [
{
"id": 1,
"manifestId": 1,
"number": "…",
"type": "…",
"state": "…"
}
],
"payment": {
"id": 1,
"accountId": 1,
"manifestId": 1,
"type": "…",
"amount": 1
},
"payments": [
{
"id": 1,
"accountId": 1,
"manifestId": 1,
"type": "…",
"amount": 1
}
],
"paid": true,
"delivered": true
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid order, invalid lines, invalid id, or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Order, entity, article, or company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._