1.6 KiB
1.6 KiB
GET /delivery
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. 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 (windowed when pagination/filters are used)
{
"deliveries": [
{
"id": 1,
"number": "…",
"type": "delivery",
"supplierId": 1,
"externalNumber": "…",
"date": "2026-08-10T00:00:00.000Z",
"createdAt": "2026-08-10T00:00:00.000Z",
"ledger": {
"totalPositions": 1,
"completelyOnLedgerPositions": 1
}
}
],
"total": 1,
"unfilteredTotal": 1,
"offset": 1,
"limit": 1
}
Errors
| Status | Description |
|---|---|
| 400 | No company selected — {"error":"…"} |
| 401 | Unauthorized — {"error":"…"} |
| 403 | Not authorized — {"error":"…"} |
| 404 | Company not found — {"error":"…"} |
Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.