API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen

Get shipment by id

GET/v1/shipments/{id}

Fetch a single shipment.

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.

Pfad-Parameter

NameTypBeschreibung
iderforderlichstring

Beispiel

curl -X GET https://api.codemeta-os.de/v1/shipments/{id} \
  -H "X-Tenant-Id: $TENANT" \
  -b cookies.txt
const result = await cm.shipments.get();

Antwortcodes

HTTP Bedeutung
200 Default Response

Suche