u

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

@@ -8,8 +8,9 @@ Creates a new shipment manifest (Lieferschein) for an order containing one, some
 If `lines` is omitted or empty, all remaining unshipped items from the order are included automatically.
 On individual line items, `amount` is optional and defaults to the remaining unshipped quantity for that article.
 Auto-assigns the shipment number formatted as `<order_number><shipment_prefix><index>`, e.g. `AUF-000001-L-1`.
+Automatically books shipment lines out on the ledger and deducts warehouse stock for stock-tracked articles.
 Updates the materialized `ordersummary` table (`shipped_quantity`, `is_shipped`) and emits SSE events
-(`order`, `shipment`) so that the order list and summary tables are rerendered in real time.
+(`order`, `shipment`, `stock`, `ledger`, `articles`) so that inventory and summaries are rerendered in real time.
 
 
 ## Path parameters
@@ -18,13 +19,14 @@ Updates the materialized `ordersummary` table (`shipped_quantity`, `is_shipped`)
 |-------|----------|------|-------------|
 | `id` | yes | integer | Order ID |
 
-## Body (JSON) — _optional_
+## Body (JSON)
 
 | Field | Required | Type | Description |
 |-------|----------|------|-------------|
 | `date` | no | string | Optional shipment date (defaults to current date) |
+| `warehouseId` | no | integer | Optional target warehouse ID to deduct stock from (defaults to company default warehouse) |
 | `externalNumber` | no | string | Optional external delivery note reference (defaults to order.externalNumber or order.number) |
-| `lines` | no | object[] | Optional positions to ship. If omitted, all remaining unshipped items are shipped. |
+| `lines` | yes | object[] | Positions to ship |
 | `lines[].sku` | yes | string | Article SKU |
 | `lines[].amount` | no | number | Quantity to ship. Defaults to remaining unshipped quantity for this SKU. |
 | `lines[].name` | no | string |  |
@@ -37,6 +39,7 @@ Updates the materialized `ordersummary` table (`shipped_quantity`, `is_shipped`)
 ```json
 {
   "date": "2026-08-10",
+  "warehouseId": 1,
   "externalNumber": "…",
   "lines": [
     {
@@ -124,7 +127,7 @@ Created shipment
 | 400 | Validation error or article not in order — `{"error":"…"}` |
 | 401 | Unauthorized — `{"error":"…"}` |
 | 404 | Order not found — `{"error":"…"}` |
-| 409 | Cumulative shipment amount exceeds ordered amount, or all items are already shipped — `{"error":"…"}` |
+| 409 | Cumulative shipment amount exceeds ordered amount, or insufficient stock — `{"error":"…"}` |
 
 ---
 

docs/api/routes/shipment.md

@@ -0,0 +1,64 @@
+# `GET /shipment`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+List shipments
+
+Company-wide paginated list of shipment manifests (`manifest` rows with `type = 'shipment'`)
+with delivery state, entityId, package tracking info, and order references.
+
+
+## Query parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `offset` | no | integer | Number of shipments to skip |
+| `limit` | no | integer | Number of shipments to return |
+| `search` | no | string | Free-text search matching shipment number, order number, external number, tracking code, or customer name |
+| `state` | no | string | Optional filter by delivery state (cancelled shipments hidden by default) |
+| `seekMonths` | no | integer | Negative integer for cutoff months ago (e.g. -1 for shipments older than 1 month) |
+
+## Response `200`
+
+Paginated shipment list
+
+```json
+{
+  "shipments": [
+    {
+      "id": 1,
+      "number": "…",
+      "type": "shipment",
+      "entityId": 1,
+      "externalNumber": "…",
+      "date": "…",
+      "createdAt": "…",
+      "orderId": 1,
+      "orderNumber": "…",
+      "customerName": "…",
+      "positions": 1,
+      "totalQuantity": 1,
+      "packageCount": 1,
+      "carrier": "…",
+      "trackingCode": "…",
+      "state": "new"
+    }
+  ],
+  "total": 1,
+  "unfilteredTotal": 1,
+  "offset": 1,
+  "limit": 1
+}
+```
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Invalid query parameters or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 403 | Not authorized — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

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

@@ -4,7 +4,7 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
 
 Delete shipment
 
-Deletes an unshipped shipment manifest. Shipped shipments cannot be deleted.
+Deletes an unshipped shipment manifest or cancels a shipped shipment restoring stock. Shipped packages cannot be deleted.
 
 ## Path parameters
 
@@ -12,6 +12,10 @@ Deletes an unshipped shipment manifest. Shipped shipments cannot be deleted.
 |-------|----------|------|-------------|
 | `id` | yes | integer | Shipment ID |
 
+## Signals
+
+On success, emits SSE signals: `shipment`, `order`, `stock`, `ledger`, `articles` (see [`GET /events`](../events.md)).
+
 ## Response `204`
 
 Shipment deleted
@@ -25,7 +29,7 @@ _No content_
 | 400 | Invalid ID or no company selected — `{"error":"…"}` |
 | 401 | Unauthorized — `{"error":"…"}` |
 | 404 | Shipment not found — `{"error":"…"}` |
-| 409 | Shipped shipment cannot be deleted — `{"error":"…"}` |
+| 409 | Shipped shipment cannot be deleted or shipment already cancelled — `{"error":"…"}` |
 
 ---