1.4 KiB
1.4 KiB
POST /order/{id}/shipping
Protected. Requires a valid session cookie (credentials: 'include').
Create shipping for an order
Creates a shipping for the order. The shipping number is allocated from the
shipping number sequence (prefix and counter from the numbers API).
If state is shipped, stock is adjusted via the ledger and article history is written.
Path parameters
| Param | Required | Type | Description |
|---|---|---|---|
id |
yes | integer | Order ID |
Body (JSON)
| Field | Required | Type | Description |
|---|---|---|---|
type |
yes | string | |
state |
yes | string | |
warehouseId |
no | integer | Optional warehouse ID for stock deduction when state is shipped |
{
"type": "…",
"state": "…",
"warehouseId": 1
}
Response 201
Created shipping
{
"shipping": {
"id": 1,
"manifestId": 1,
"number": "…",
"type": "…",
"state": "…"
}
}
Errors
| Status | Description |
|---|---|
| 400 | Validation error or no company selected — {"error":"…"} |
| 401 | Unauthorized — {"error":"…"} |
| 403 | Not authorized — {"error":"…"} |
| 404 | Order or warehouse not found — {"error":"…"} |
| 409 | Order already shipped — {"error":"…"} |
Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.