API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · shipments

Shipment Schema

Schema-ID
shipment
Collection
shipments
Permissions
  • Lesenshipment_view
  • Anlegenshipment_create
  • Ändernshipment_edit
  • Löschenshipment_delete

Felder

Shipment Schema

shipments4 Permissions

Schema for validating Lieferschein (delivery note / shipment) entities

salesOrderIduuiderforderlich

Linked sales order UUID

partyIdstringoptional

Customer party UUID (denormalized from sales order for data scope filtering)

PatternDefault: nullnullable
shipmentNumberstringoptional

Auto-generated shipment number (e.g. LS-2026-00001)

max 30 ZeichenDefault: nullread-onlynullable
shipmentDatedateoptional

Shipping date (YYYY-MM-DD)

Default: nullnullable
deliveryDatedateoptional

Planned or actual delivery date

Default: nullnullable
statusstringerforderlich

Shipment lifecycle status

Werte
OPENSHIPPEDDELIVEREDCANCELLED
Default: "OPEN"
recipientAddressobjectoptional

Delivery recipient address (snapshot)

Default: nullnullable
itemsobject[]optional

Shipped items

Default: []
iduuiderforderlich
salesOrderItemIdstringoptional

Reference to the sales order item

PatternDefault: nullnullable
articleIduuiderforderlich
articleNamestringoptional
max 300 ZeichenDefault: nullnullable
articleNumberstringoptional
max 100 ZeichenDefault: nullnullable
quantitystringerforderlich

Shipped quantity (decimal)

Pattern
unitstringoptional
max 20 ZeichenDefault: nullnullable
serialNumbersstring[]optional

Assigned serial numbers

Default: []
parcelsobject[]optional

Package tracking information

Default: []
iduuiderforderlich
trackingNumberstringoptional
max 200 ZeichenDefault: nullnullable
trackingUrlstringoptional
max 500 ZeichenDefault: nullnullable
carrierstringoptional

Carrier name (DHL, UPS, DPD, etc.)

max 100 ZeichenDefault: nullnullable
weightstringoptional

Package weight in kg

PatternDefault: nullnullable
notestringoptional

Delivery notes

max 2000 ZeichenDefault: nullnullable
internalNotestringoptional

Internal notes (not visible to customer)

max 4000 ZeichenDefault: nullnullable
externalReferencesobject[]optional

External system references (e.g. weclapp)

Default: []
systemstringerforderlich
max 50 Zeichen
externalIdstringerforderlich
max 200 Zeichen
externalVersionstringoptional
Default: nullnullable
syncedAtdatetimeoptional
Default: nullnullable
urlstringoptional
max 500 ZeichenDefault: nullnullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/shipments — Liste, paginiert + filterbar
  • GET /api/v1/shipments/<id> — Einzelne Entity
  • POST /api/v1/shipments — Anlegen
  • PATCH /api/v1/shipments/<id> — Teil-Update
  • DELETE /api/v1/shipments/<id> — Soft-Delete
  • GET /api/v1/shipments/<id>/timeline — Audit + Aktivitäten

Suche