MEDIIO API-Initiative

Anwendungsfall · Auftragsstatus & Liefertermin

Auftragsstatus & Liefertermin in Echtzeit

Status und voraussichtlichen Liefertermin zu einer Bestellung direkt beim Lieferanten abrufen – inklusive Teil-/Vollständigkeit. Keine Rückfrage im Kundenservice mehr.

GET /api/Order/Status
api.host · REST
GET /api/Order/Status?OrderId=4711
{
  "orderStatus": "inProcess",
  "orderPositions": [
    { "positionNumber": "10", "deliveryStatus": "partially" }
  ]
}

User Story

„Ich möchte als Anforderer bzw. Besteller den Auftragsstatus inkl. Liefertermin zu einer Bestellung bei meinem Lieferanten erfragen und zusätzlich wissen, ob diese vollständig geliefert wird, damit ich nicht im Kundenservice des Lieferanten nachfragen muss und Auskunft geben kann, ob die bestellte Ware rechtzeitig ankommt und z. B. eine geplante OP durchgeführt werden kann."

Rahmen

Wie der Auftragsstatus abgebildet wird

Eine Kundenbestellung wird über Kundennummer und Bestellnummer identifiziert. Die Antwort beschreibt den Fortschritt auf Kopf- und Positionsebene – abgeleitet aus den Akzeptanzkriterien.

Eine Bestellung, mehrere Aufträge

Eine Kundenbestellung kann beim Lieferanten zu 1..n Aufträgen führen; der Status wird gebündelt zurückgegeben.

Status auf Kopf- & Positionsebene

Gesamtstatus der Bestellung plus je Position: vollständig, teilweise oder nicht lieferbar.

Liefertermine je (Teil-)Lieferung

Pro Teillieferung: Liefermenge, Liefertermin sowie optional Transportdienstleister und Sendungsnummer.

Weniger Rückfragen

Auskunftsfähig ohne Anruf im Kundenservice – z. B. für die verlässliche Planung einer OP.

Bewusst abgegrenzt

  • Rückmeldung erfolgt on demand per Abfrage – ein Event-Push ist nicht Teil dieses Endpunkts.
  • Belege wie Lieferschein und Rechnung werden über gesonderte Endpunkte behandelt.

Aufruf

Parameter

Beide Parameter sind Pflicht und identifizieren die Bestellung eindeutig.

Parameter Query Bedeutung
Kundennummer des Bestellers ?OrderNumberCustomer=12345 Kundenidentifikation beim Lieferanten (Pflicht).
Bestellnummer des Kunden &OrderId=4711 Bestellnummer der Kundenbestellung (Pflicht).

Optional kann zusätzlich die eindeutige Bestellnummer (ID) der Plattform mitgeführt werden.

Beispiel

Typische Abfrage

Als Konsument möchte ich … – und rufe dafür folgenden Endpunkt auf:

den Auftragsstatus zu einer Bestellung abfragen

GET
https://host_url/api/Order/Status?OrderNumberCustomer=12345&OrderId=4711

Antwort

Response (JSON)

Kopfstatus (orderStatus) plus Positionen (orderPositions). Jede Position trägt einen Lieferstatus und – bei (Teil-)Lieferung – 1..n Detailzeilen mit Menge, Liefertermin und optional Transporteur/Sendungsnummer.

Response · application/json
{
  "orderStatus": "Received",
  "orderNumberSupplierSystem": "string",
  "orderPositions": [
    {
      "positionNumber": "string",
      "deliveryStatus": "Partially",
      "deliveryStatusRemark": "string",
      "detailStatus": [
        {
          "quantity": 0,
          "uom": "string",
          "deliveryDateTime": "2026-04-15T11:49:32.735Z",
          "shipmentServiceProvider": "string",
          "shipmentTrackingId": "string"
        }
      ]
    }
  ]
}

Wichtige Felder

orderStatus

Gesamtstatus der Bestellung (received / inProcess / completed / canceledByCustomer).

orderNumberSupplierSystem

Auftragsnummer aus dem Lieferantensystem (optional).

orderPositions[]

Positionen der Kundenbestellung.

positionNumber

Positionsnummer aus der Kundenbestellung, z. B. „10".

deliveryStatus

Lieferstatus der Position (full / partially / rejected).

deliveryStatusRemark

Freitext-Anmerkung bzw. Statusgrund.

detailStatus[]

(Teil-)Lieferungen: 1..n bei Lieferung, leer bei rejected.

quantity / uom

Liefermenge und Mengeneinheit.

deliveryDateTime

Voraussichtlicher Liefertermin (ISO 8601).

shipmentServiceProvider / shipmentTrackingId

Transportdienstleister und Sendungsnummer (optional).

Statuswerte

Was die Statusfelder bedeuten

Auftragsstatus (Kopfebene)

  • received Empfangen – im Lieferantensystem wurde ein Auftrag angelegt.
  • inProcess In Bearbeitung – mindestens eine Position wird kommissioniert.
  • completed Erledigt – die letzte Position der Bestellung ist abgeschlossen.
  • canceledByCustomer Vom Kunden storniert.

Lieferstatus (Positionsebene)

  • full Vollständig – eine Detailzeile mit Menge & Liefertermin.
  • partially Teilweise – 1..n Detailzeilen mit Menge & Liefertermin.
  • rejected Nicht lieferbar – keine Detailzeile (leer).

Statusgründe

nullnotInStockcanceledByCustomercanceledBySupplierreplacementunknownArticledeliveryDisruption

Anmerkung (deliveryStatusRemark) z. B.: „Nachfolgerartikel ist 4711".

Selbsttest

Antwort prüfen

Fügen Sie die JSON-Antwort Ihres /api/Order/Status-Endpunkts ein – die Struktur wird sofort im Browser gegen dieses Schema geprüft.

Noch keine Prüfung – JSON einfügen und „Prüfen" klicken.

Diesen Anwendungsfall in Ihrem System nutzen?

Werden Sie Teil der API-Initiative – wir begleiten Sie beim Onboarding.