u

docs/api/routes/delivery/list.md

@@ -5,12 +5,23 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
 List deliveries
 
 Lists goods receipts (`manifest` rows with `type = 'delivery'`)
-for the authenticated user's selected company.
+for the authenticated user's selected company. Supports pagination and filtering.
 
 
+## Query parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `offset` | no | integer | Number of records to skip |
+| `limit` | no | integer | Number of records to return (1-1000) |
+| `search` | no | string | Substring match for delivery number, external number, or supplier name |
+| `onlyUnbooked` | no | boolean | When true, returns only deliveries with unbooked stock items |
+| `supplierId` | no | integer | Filter by supplier entity id |
+| `seekMonths` | no | integer | Negative integer cutoff months ago (e.g. -1) |
+
 ## Response `200`
 
-Delivery list
+Delivery list (windowed when pagination/filters are used)
 
 ```json
 {
@@ -28,7 +39,11 @@ Delivery list
         "completelyOnLedgerPositions": 1
       }
     }
-  ]
+  ],
+  "total": 1,
+  "unfilteredTotal": 1,
+  "offset": 1,
+  "limit": 1
 }
 ```