`PATCH /shipment/{id}`

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

Update shipment state or metadata

Updates delivery state (new, delivered) for the shipment. Emits SSE events (shipment, order) so connected clients rerender in real time.

Path parameters

Param	Required	Type	Description
`id`	yes	integer	Shipment ID

Body (JSON)

Field	Required	Type	Description
`state`	no	string	Delivery state

{
  "state": "delivered"
}

Signals

On success, emits SSE signals: shipment, order (see GET /events).

Response `200`

Updated shipment

{
  "shipment": {
    "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"
  }
}

Errors

Status	Description
400	Invalid state, invalid ID, or no company selected — `{"error":"…"}`
401	Unauthorized — `{"error":"…"}`
404	Shipment not found — `{"error":"…"}`

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

2.2 KiB Raw Permalink Blame History

PATCH /shipment/{id}