Files

seb 7514848022 Delivery API: use externalNumber for user reference

Delivery create now accepts externalNumber (user-supplied reference) instead
of number; the manifest number is auto-allocated server-side via
nextNumber('delivery'). Update patches externalNumber (clearable) rather than
number. DeliverySummary schema documents externalNumber and notes number is
auto-generated. Regenerate API docs.

2026-08-08 10:09:32 +02:00

1.4 KiB

Raw Blame History

`PATCH /delivery/{id}`

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

Update delivery

Patches header fields that are present. The manifest number is auto-allocated and cannot be patched; only the user-supplied externalNumber reference is editable. If lines is present, replaces all lines; if omitted, leaves lines unchanged.

Path parameters

Param	Required	Type	Description
`id`	yes	integer

Body (JSON)

{
  "externalNumber": "DHL-124",
  "lines": []
}

Response `200`

Updated delivery

{
  "delivery": {
    "id": 1,
    "number": "…",
    "type": "delivery",
    "supplierId": 1,
    "externalNumber": "…",
    "date": "2026-08-10T00:00:00.000Z",
    "lines": [
      {
        "id": 1,
        "articleId": 1,
        "sku": "…",
        "amount": 1,
        "net": 1,
        "transactedAmount": 1,
        "rebate": 1,
        "tax": 1,
        "comment": "…"
      }
    ]
  }
}

Errors

Status	Description
400	Invalid delivery, invalid lines, invalid id, or no company selected — `{"error":"…"}`
401	Unauthorized — `{"error":"…"}`
403	Not authorized — `{"error":"…"}`
404	Delivery, supplier, article, or company not found — `{"error":"…"}`

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

1.4 KiB Raw Blame History

PATCH /delivery/{id}