List shipments

GET/v1/shipments

List shipments for the active tenant.

Datenmodell

Diese Operation arbeitet auf der Entität Shipment (shipment). Alle 12 Felder — Typ, Validierung, Pflichtangabe, Beziehungen — stehen in der Schema-Referenz.

Pflichtfelder: salesOrderId, status
Server-verwaltet: _id, schema, schemaVersion, tenantId, version, createdAt, updatedAt, createdBy, updatedBy, deletedAt, deletedBy, shipmentNumber — diese Felder vergibt die Plattform; im Request werden sie verworfen.

Query-Parameter

Name	Typ	Beschreibung
`cursor`	`string`
`limit`	`number`
`includeDeleted`	`boolean`

Beispiel

curl -X GET https://api.codemeta-os.de/v1/shipments \
  -H "X-Tenant-Id: $TENANT" \
  -b cookies.txt

const result = await cm.shipments.list();

Antwortcodes

HTTP	Bedeutung
`200`	Default Response