u

docs/api/routes/shipment/_id.get.md

@@ -0,0 +1,69 @@
+# `GET /shipment/{id}`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+Get shipment by ID
+
+Retrieves shipment header, article positions, and attached packages.
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Shipment ID |
+
+## Response `200`
+
+Shipment details
+
+```json
+{
+  "shipment": {
+    "id": 1,
+    "number": "…",
+    "type": "shipment",
+    "entityId": 1,
+    "externalNumber": "…",
+    "date": "…",
+    "createdAt": "…",
+    "lineCount": 1,
+    "packageCount": 1,
+    "lines": [
+      {
+        "id": 1,
+        "sku": "…",
+        "name": "…",
+        "pu": 1,
+        "amount": 1,
+        "net": 1,
+        "rebate": 1,
+        "taxrate": 1,
+        "comment": "…"
+      }
+    ],
+    "shippings": [
+      {
+        "id": 1,
+        "manifestId": 1,
+        "number": "…",
+        "trackingCode": "…",
+        "carrier": "…",
+        "type": "…",
+        "state": "…"
+      }
+    ]
+  }
+}
+```
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Invalid ID or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 404 | Shipment not found — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._