Files
dashback/docs/api/routes/order/_id/shipment.get.md
2026-10-17 05:10:25 +02:00

1.9 KiB

GET /order/{id}/shipment

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

List shipments of an order

Lists all shipment manifests belonging to the specified order.

Path parameters

Param Required Type Description
id yes integer Order ID

Response 200

List of shipments

{
  "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": "…"
        }
      ],
      "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"
    }
  ]
}

Errors

Status Description
400 Invalid ID or no company selected — {"error":"…"}
401 Unauthorized — {"error":"…"}
404 Order not found — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.