seb/dashback
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Delivery API: use externalNumber for user reference

Browse Source 
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.
This commit is contained in:
seb
2026-08-08 10:09:32 +02:00
parent 57420ac0db
commit 7514848022
7 changed files with 60 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/api/openapi.json
View File

@@ -4119,7 +4119,7 @@
"Delivery"
],
"summary": "Create delivery",
"description": "Creates a goods receipt with header and lines in one transaction.\nEach line requires `sku`, `amount`, `net`, and `tax` (rate).\n`rebate` defaults to `0`; `transactedAmount` defaults to `amount`.\n",
"description": "Creates a goods receipt with header and lines in one transaction.\nThe manifest `number` is allocated automatically via\n`nextNumber('delivery')`; the user-supplied reference is stored as\n`externalNumber`. Each line requires `sku`, `amount`, `net`, and\n`tax` (rate). `rebate` defaults to `0`; `transactedAmount` defaults\nto `amount`.\n",
"security": [
{
"cookieAuth": []
@@ -4133,13 +4133,14 @@
"schema": {
"type": "object",
"required": [
"number",
"externalNumber",
"date",
"lines"
],
"properties": {
"number": {
"type": "string"
"externalNumber": {
"type": "string",
"description": "User-supplied reference number"
},
"date": {
"type": "string",
@@ -4157,7 +4158,7 @@
}
},
"example": {
"number": "DHL-123",
"externalNumber": "DHL-123",
"date": "2026-08-10",
"supplierId": 1,
"lines": [
@@ -4318,7 +4319,7 @@
"Delivery"
],
"summary": "Update delivery",
"description": "Patches header fields that are present. If `lines` is present, replaces\nall lines; if omitted, leaves lines unchanged. Returns the full delivery.\n",
"description": "Patches header fields that are present. The manifest `number` is\nauto-allocated and cannot be patched; only the user-supplied\n`externalNumber` reference is editable. If `lines` is present,\nreplaces all lines; if omitted, leaves lines unchanged.\n",
"security": [
{
"cookieAuth": []
@@ -4342,8 +4343,10 @@
"schema": {
"type": "object",
"properties": {
"number": {
"type": "string"
"externalNumber": {
"type": "string",
"nullable": true,
"description": "User-supplied reference number (empty/null clears it)"
},
"date": {
"type": "string",
@@ -4361,7 +4364,7 @@
}
},
"example": {
"number": "DHL-124",
"externalNumber": "DHL-124",
"lines": []
}
}
@@ -8804,7 +8807,8 @@
"type": "integer"
},
"number": {
"type": "string"
"type": "string",
"description": "Auto-allocated via nextNumber('delivery')"
},
"type": {
"type": "string",
@@ -8817,6 +8821,11 @@
"nullable": true,
"description": "manifest.entity_id"
},
"externalNumber": {
"type": "string",
"nullable": true,
"description": "User-supplied reference number"
},
"date": {
"type": "string",
"format": "date-time"

10
docs/api/routes/delivery/create.md
View File

@@ -5,15 +5,18 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
Create delivery
Creates a goods receipt with header and lines in one transaction.
Each line requires `sku`, `amount`, `net`, and `tax` (rate).
`rebate` defaults to `0`; `transactedAmount` defaults to `amount`.
The manifest `number` is allocated automatically via
`nextNumber('delivery')`; the user-supplied reference is stored as
`externalNumber`. Each line requires `sku`, `amount`, `net`, and
`tax` (rate). `rebate` defaults to `0`; `transactedAmount` defaults
to `amount`.
## Body (JSON)
```json
{
"number": "DHL-123",
"externalNumber": "DHL-123",
"date": "2026-08-10",
"supplierId": 1,
"lines": [
@@ -38,6 +41,7 @@ Created delivery
"number": "…",
"type": "delivery",
"supplierId": 1,
"externalNumber": "…",
"date": "2026-08-10T00:00:00.000Z",
"lines": [
{

1
docs/api/routes/delivery/get.md
View File

@@ -23,6 +23,7 @@ Delivery
"number": "…",
"type": "delivery",
"supplierId": 1,
"externalNumber": "…",
"date": "2026-08-10T00:00:00.000Z",
"lines": [
{

1
docs/api/routes/delivery/list.md
View File

@@ -20,6 +20,7 @@ Delivery list
"number": "…",
"type": "delivery",
"supplierId": 1,
"externalNumber": "…",
"date": "2026-08-10T00:00:00.000Z"
}
]

9
docs/api/routes/delivery/update.md
View File

@@ -4,8 +4,10 @@ Protected. Requires a valid session cookie (`credentials: 'include'`).
Update delivery
Patches header fields that are present. If `lines` is present, replaces
all lines; if omitted, leaves lines unchanged. Returns the full 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
@@ -18,7 +20,7 @@ all lines; if omitted, leaves lines unchanged. Returns the full delivery.
```json
{
"number": "DHL-124",
"externalNumber": "DHL-124",
"lines": []
}
```
@@ -34,6 +36,7 @@ Updated delivery
"number": "…",
"type": "delivery",
"supplierId": 1,
"externalNumber": "…",
"date": "2026-08-10T00:00:00.000Z",
"lines": [
{