# `GET /order`

Protected. Requires a valid session cookie (`credentials: 'include'`).

List orders

Lists sales orders (`manifest` rows with `type = 'order'`)
for the authenticated user's selected company.
Results are paged, include line items, shipping, payment, and provide total unpaged count as well as unfiltered count.


## Query parameters

| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `offset` | no | integer | Number of orders to skip |
| `limit` | no | integer | Number of orders to return |
| `search` | no | string | Free-text search matching order number, external number, or customer name |
| `onlyUnpaid` | no | boolean | When true, returns only unpaid orders (including overpaid orders) |
| `onlyUndelivered` | no | boolean | When true, returns only undelivered orders |
| `seekMonths` | no | integer | Negative integer for cutoff months ago (e.g. -1 for orders older than 1 month) |

## Response `200`

Order list

```json
{
  "orders": [
    {
      "id": 1,
      "number": "…",
      "type": "order",
      "entityId": 1,
      "externalNumber": "…",
      "date": "2026-08-10T00:00:00.000Z",
      "createdAt": "2026-08-10T00:00:00.000Z",
      "lines": [
        {
          "id": 1,
          "sku": "…",
          "name": "…",
          "pu": 1,
          "amount": 1,
          "net": 1,
          "rebate": 1,
          "taxrate": 1,
          "comment": "…",
          "shippable": true
        }
      ],
      "shipping": {
        "id": 1,
        "manifestId": 1,
        "number": "…",
        "trackingCode": "…",
        "carrierId": 1,
        "carrier": "…",
        "type": "…",
        "state": "…"
      },
      "shippings": [
        {
          "id": 1,
          "manifestId": 1,
          "number": "…",
          "trackingCode": "…",
          "carrierId": 1,
          "carrier": "…",
          "type": "…",
          "state": "…"
        }
      ],
      "payment": {
        "id": 1,
        "accountId": 1,
        "manifestId": 1,
        "type": "…",
        "amount": 1
      },
      "payments": [
        {
          "id": 1,
          "accountId": 1,
          "manifestId": 1,
          "type": "…",
          "amount": 1
        }
      ],
      "paid": true,
      "shipped": true,
      "delivered": true,
      "orderTotal": 1,
      "paidTotal": 1,
      "orderedQuantity": 1,
      "shippedQuantity": 1,
      "shipments": [
        {
          "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": "…",
              "shippable": true
            }
          ],
          "shippings": [
            {
              "id": 1,
              "manifestId": 1,
              "number": "…",
              "trackingCode": "…",
              "carrierId": 1,
              "carrier": "…",
              "type": "…",
              "state": "…"
            }
          ],
          "files": [
            {
              "id": 1,
              "manifestId": 1,
              "fileId": 1,
              "sort": 1,
              "hash": "…",
              "mimetype": "…",
              "name": "…",
              "size": 1,
              "created": "2026-08-10T00:00:00.000Z",
              "modified": "2026-08-10T00:00:00.000Z",
              "skeledash": "…",
              "thumbx": 1,
              "thumby": 1,
              "meta": {}
            }
          ],
          "state": "new"
        }
      ],
      "files": [
        {
          "id": 1,
          "manifestId": 1,
          "fileId": 1,
          "sort": 1,
          "hash": "…",
          "mimetype": "…",
          "name": "…",
          "size": 1,
          "created": "2026-08-10T00:00:00.000Z",
          "modified": "2026-08-10T00:00:00.000Z",
          "skeledash": "…",
          "thumbx": 1,
          "thumby": 1,
          "meta": {}
        }
      ]
    }
  ],
  "total": 1,
  "unfilteredTotal": 1,
  "offset": 1,
  "limit": 1
}
```

## Errors

| Status | Description |
|--------|-------------|
| 400 | Invalid query parameters, invalid offset, invalid limit, or 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`._