V1_0

Sendungsstatus-Schnittstelle

Übertragung und Aktualisierung von Sendungsdaten, einschließlich des Status von Meilensteinen, von Scope an den Kunden

Top Features

Die Sendungsstatus-Schnittstelle ist eine unidirektionale ausgehende Schnittstelle. Sie sendet Sendungsdetails einschließlich aller 'Web-sichtbaren' Meilensteinstatus an konfigurierte beteiligte Drittparteien, wenn diese als Kunde, Versender, Empfänger oder Notify an der Sendung beteiligt sind. Die Schnittstelle deckt alle trackingfähigen operativen Sendungen (und Buchungen) ab und wird bei Änderungen an den Sendungsdaten ausgelöst, einschließlich Änderungen im Trackingplan der Sendung.

ShipmentStatusInterface_shipment and tracking data

Voraussetzung und technische Informationen

Zwischen dem Riege-Rechenzentrum und dem Empfänger der Ereignisdaten wird ein technischer Datenkommunikationskanal benötigt. Dieser Kanal bekommt von Riege eine recipientID zugewiesen. Die recipientID wird für die Einrichtung in Scope benötigt.

Alle Scope Niederlassungen sind potenzielle Absender von Ereignismeldungen und bekommen eine senderID zugewiesen. Der Standardwert der senderID ist der Code des entsprechenden Geschäftspartners. Die senderIDs sollten auch für das Setup im Riege-internen Nachrichtenclearing mit Riege abgeglichen werden.
  • Die Schnittstelle sendet Aktualisierungen aber keine Stornierungen, wenn Drittparteien von der Sendung entfernt werden
  • Jede Änderung der Sendung oder des Trackingplans löst eine neue Übertragung an die beteiligten Drittparteien aus, sofern diese als Empfänger konfiguriert sind.
  • Die Beschreibung des Scope Shipment Status Formats ist verfügbar unter
    https://riege.github.io/xml-shipmentupdate

Scope Setup - EDI Profile

Für die Sendungsstatus-Schnittstelle wird ein EDI-Profil benötigt.

Für das EDI-Profil selbst gelten die folgenden Regeln:
  • Der Code ist frei wählbar
  • Referenztyp-Code spielt keine Rolle, typische Werte sind 'ptt' oder 'shipmentPtt' oder 'usi'
  • Der Typ der Schnittstelle muss auf Shipment Updates eingestellt sein.
  • Die Adresszuordnung muss die eigene Niederlassung oder alle Niederlassungen enthalten, damit die Schnittstelle ausgelöst wird (jede externe ID muss hier mit einer senderID übereinstimmen).
  • Adresszuordnungen müssen alle konfigurierten Empfängerpartner enthalten, bei denen die externe ID mit der recipientID übereinstimmt. 
Zusätzliche Konfiguration in Tracking-Vorlagen ist nicht erforderlich, alle öffentlich sichtbaren Meilensteine oder Ausnahmen sind im Tracking-Plan enthalten.

Jede Änderung der Sendung oder des Trackingplans löst die Übertragung einer Sendungsstatusmeldung aus. Scope verwendet eine kurze Verzögerung, um das Nachrichtenvolumen unter Kontrolle zu halten.