u

docs/api/routes/order/_id/shipping.post.md

@@ -0,0 +1,58 @@
+# `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).
+
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Order ID |
+
+## Body (JSON)
+
+| Field | Required | Type | Description |
+|-------|----------|------|-------------|
+| `type` | yes | string |  |
+| `state` | yes | string |  |
+
+```json
+{
+  "type": "…",
+  "state": "…"
+}
+```
+
+## Response `201`
+
+Created shipping
+
+```json
+{
+  "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 not found — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._