shiptrack.com SOAP Schnittstelle - deutsch

1      Allgemein

1.1    Änderungshistorie

Rev. NrDatumFirmaMitarbeiterBeschreibung der Änderung

1.0

16.09.2015

MHP

ML

Erstellung des Dokuments

1.1

07.07.2016

MHP

MWi

Ergänzung der einzelnen Ebenen bei den optionalen Feldern und Anpassungen am Format des Dokuments

1.2

05.09.2016

MHP

ML

WSDL überarbeitet, Zugang Testsystem erstellt

1.3

13.09.2016

MHP

LK

Ergänzung fehlender Frachtführerkürzel

1.4

13.06.2017

MHP

LRS

Ergänzung der fehlenden Frachtführerkürzel und Hinzufügen neuer Parameter

1.5

15.06.2017

MHP

LRS

Ergänzung um weitere Parameter und Frachtführerkürzel

1.6

19.06.2017

MHP

LRS

Allg. Anpassungen u. weitere Parameter

1.7

22.06.2017

MHP

LRS

Erweiterung um Sendungsanlage mittels PUT

1.8

23.06.2017

MHP

LRS

Ergänzung um neue WSDLs

1.8.1

16.08.2017

MHP

LK

Layout-Anpassungen

1.8.3

21.12.2017

MHP

ML

Shipmenttags & VorsystemIds rein rein  Testsystem raus

1.8.420.02.2019MHPMLZusätzliche Objekte wie Dokumente, Incidents und Timings
1.8.504.08.2020MHPRSUpdate Frachtführerkürzel
1.8.609.04.2021MHPMWiAktualisierung übermittelter Felder
1.8.708.07.2021MHPRSErgänzung fehlender Frachtführerkürzel
1.8.912.08.2021MHPMWiRemoved onlyUpdates parameter
1.8.9.127.09.2021MHPMWiFrachtführerkürzel AMM hinzugefügt

1.2    Einführung


Nachfolgend wird die SOAP Schnittstelle beschrieben, die vom Shiptrack.com Service angeboten. Die Schnittstelle arbeitet nach dem SOAP-Standard. Die Authentifizierung des Nutzers der Schnittstelle wird mit der HTTP-Basic Authentifizierung durchgeführt.

1.3    Fehlerbehandlung

Damit bei einem auftretenden Fehler in der Schnittstelle der Aufrufer eine aussagekräftige Fehlermeldung bekommt, sendet die Schnittstelle eine Antwort mit einem HTTP-Statuscode, der den Fehler repräsentiert. Außerdem wird eine Nachricht zurückgeliefert, die Detailinformationen zum Fehler enthält. Für den Fehler, dass ein Kunde als Parameter angegeben wird, der nicht existiert, wird zum Beispiel der HTTP-Statuscode 404 zurückgesendet. Die dazugehörige Detail-Fehlermeldung sieht wie folgt aus:

Der Standardfehlercode für undefinierte Fehler ist der HTTP-Statuscode 505. Nachfolgend ist eine Tabelle mit allen bekannten Shiptrack.com spezifischen Fehlercodes aufgelistet:

Fehlercode

HTTP-Status

Beschreibung

404.1

404

Die angegebene Client-Id existiert nicht in der Datenbank

400.1

400

Das angegebene Datumsformat im since-Parameter entspricht nicht den Richtlinien

500.1

500

Es ist kein Statusbaum konfiguriert um die Status auszuwerten

2      Sendungsverfolgungsdaten

Über die SOAP Schnittstellen können die Sendungsverfolgungsdaten mithilfe von zwei Funktionen abgerufen werden, die ein gefiltertes Ergebnis der gesamten Sendungsverfolgungsdaten eines Kunden zurückliefern. Beide Funktionen liefern das Ergebnis in Form eines XML-Strings, dessen Format im nachfolgenden Kapitel erläutert wird.  Die zugehörige WSDL die den SOAP Webservice beschreibt befindet sich im Anhang.


2.1    Sammelabfrage

URL Livesystem: https://service.shiptrack.com:8443/shipments

Der Parameter Client-Id muss mit der mitgeteilten Kunden-Id gefüllt werden.


2.1.1    GET

Mit der http-Methode GET werden alle Sendungen, die den Kunden mit der in der URL angegebenen Client-Id zugeordnet sind auf. Das Ergebnis wird als XML zurückgeliefert und als Stream übertragen. Die Liste der Sendungsdaten die zurückgeschickt wird, kann mit folgenden optionalen GET Parametern eingeschränkt werden:

  • since Wird dieser Parameter angegeben, werden nur Datensätze zurückgeliefert, die seit dem Zeitpunkt importiert oder bei denen neue Daten hinzugefügt wurden.
    Datentyp:
    Datum - Format(YYYYMMddHHmmss) in der Zeitzone UTC oder ISO-8601
  • until Wird dieser Parameter angegeben, werden nur Datensätze zurückgeliefert, die bis zu dem Zeitpunkt importiert oder bei denen neue Daten hinzugefügt wurden.
    Datentyp:
    Datum - Format(YYYYMMddHHmmss) in der Zeitzone UTC oder ISO-8601

2.2    Einzelabfrage

URL:  https://service.shiptrack.com:8443/shipmentsSearch

Der Parameter Client-Id muss mit der mitgeteilten Kunden-Id gefüllt werden.


2.2.1    GetWithTrackingNr

Führt eine Suche auf der Trackingnummer einer Sendung oder eines Paketes durch. Es wird immer die komplette Sendung zurückgeliefert auch wenn die Trackingnummer sich auf Paketebene findet. Betroffene Felder sind: shipment_tracking_id auf Sendungsebene und send_id auf Paketebene.

Parameter

Beschreibung

client

Id des Shiptrack.com Kunden. Wird von MHP mitgeteilt.

trackingNr

Trackingnummer nach der gesucht werden soll.

2.2.2    GetWithReferenceNr

Dieser Aufruf ermöglicht eine Suche auf den Referenznummern einer Sendung, sowohl auf Sendungs- als auch auf Paketebene. Der angegebene Wert wird in folgenden Feldern gesucht: send_referenznr_01, send_referenznr_02, send_referenznr_03, send_referenznr_04, send_referenznr_05 auf Sendungsebene und send_referenznr_06, send_referenznr_07, send_referenznr_08, send_referenznr_09, send_referenznr_10 auf Paketebene.

Parameter

Beschreibung

client

Id des Shiptrack.com Kunden. Wird von MHP mitgeteilt.

referenceNr

Referenznummer nach der gesucht werden soll.

2.3    Sendungsanlage via PUT

Mit Hilfe des http-Verbs PUT lassen sich sowohl einzelne als auch mehrere Sendungen an den Service übermitteln. Zur erfolgreichen Übermittlung müssen die in Abschnitt 2.3.1 definierten Minimalfelder angegeben werden.

Nach erfolgreicher Übermittlung stehen die Daten stehen die Daten nicht sofort zum Abruf über die Sammel- oder Einzelabfrage zur Verfügung sondern müssen zunächst durch den Service

abgearbeitet werden

2.3.1    Minimale Felder für die Anlage einer Sendung

Parameter

Beschreibung

shipment_tracking_id

Tracking-Sendungsnummer des Frachtführers

frachtfuehrer

Kürzel des Frachtführers

send_versanddatum

Datum an dem die Sendung versendet wurde

2.3.2   Beispiel für die Anlage einer Sendung

<?xml version="1.0" encoding="utf-8"?>
<workitem>
	<shipment collection="true">		
		<frachtfuehrer>HVS</frachtfuehrer>		
		<send_versanddatum>
			<date>01/22/2017</date>
		</send_versanddatum>
		<shipment_tracking_id>365767978452</shipment_tracking_id>
	</shipment>
</workitem>


2.4    Sendungsverfolgungsdatenformat

Nachfolgend wird das Format der Sendungsverfolgungsdaten, welche von der Schnittstelle zurückgeliefert und angenommen werden erläutert.


Die Übertragung der Daten findet im XML-Format statt. Die Kodierung des XML erfolgt immer als UTF-8 und beginnt mit dem Tag „workitem“. Innerhalb des Tags „workitem“ können eine oder mehrere Sendungen übergeben werden. Eine Sendung wird dabei immer mit dem Tag „shipment“ eingeleitet. Wichtig dabei ist, dass bei dem „shipment“ Tag immer das Attribut „collection“ mit dem Wert „true“ vorhanden ist. Ebenso werden alle Tags, die in dem XML vorkommen, kleingeschrieben.

Beispiel der Grundstruktur:

<?xml version="1.0" encoding="utf-8"?>
<workitem>
  <shipment collection="true">
    <package collection="true">
      <article collection="true">       
      </article>
    </package>
  </shipment>
</workitem>


Beispiel der Grundstruktur mit mehreren Sendungen:

<?xml version="1.0" encoding="utf-8"?>
<workitem>
  <shipment collection="true">
    <package collection="true">
      <article collection="true">        
      </article>
    </package>
  </shipment>
  <shipment collection="true">
    <package collection="true">
      <article collection="true">        
      </article>
    </package>
  </shipment>
  <shipment collection="true">
    <package collection="true">
      <article collection="true">        
      </article>
    </package>
  </shipment>
</workitem>


Eine Sendung kann wiederum ein oder mehrere Pakete enthalten. Ein Paket wird dabei mit dem Tag „package“ eingeleitet. Auch bei diesem Tag muss das Attribut „collection“ mit dem Wert „true“ angegeben werden.

Beispiel einer Sendung mit einem Paket:

<?xml version="1.0" encoding="utf-8"?>
<workitem>
  <shipment collection="true">
    <package collection="true">      
    </package>
  </shipment>
</workitem>


Beispiel einer Sendung mit mehreren Paketen:

<?xml version="1.0" encoding="utf-8"?>
<workitem>
  <shipment collection="true">
    <package collection="true">   
   
    </package>
    <package collection="true">

     </package>
    <package collection="true"> 

    </package>
  </shipment>
</workitem>


Somit wird mindestens folgende Nachricht übertragen:

<?xml version="1.0" encoding="utf-8"?>
<workitem>
  <shipment_count>0</shipment_count>
</workitem>

Eine Abfrage mit Daten ist wie folgt aufgebaut:

<?xml version="1.0" encoding="utf-8"?>
<workitem>
  <shipment collection="true">
    <frachtfuehrer>UPS</frachtfuehrer>
    <abs_adr_01>MHP SOFTWARE GMBH</abs_adr_01>
    <empf_adr_01>ROSEN VERSENDER</empf_adr_01>
    <empf_adr_02>ZHD ROSENVERKAEFAUER 1</empf_adr_02>
    <abs_strasse>JUSTUS-VON-LIEBIG-STRASSE 3</abs_strasse>
    <abs_ort>NEUSTADT A. RBGE.</abs_ort>
    <abs_plz>31535</abs_plz>
    <abs_land_kurz>DE</abs_land_kurz>
    <empf_strasse>MARIA-KIRCHNER-STR. 32</empf_strasse>
    <empf_ort>ARNSTORF</empf_ort>
    <empf_plz>94424</empf_plz>
    <empf_land_kurz>DE</empf_land_kurz>
    <send_referenznr_01>5601519</send_referenznr_01>
    <send_abholdatum>
      <date>03/24/2014</date>
    </send_abholdatum>
    <send_versanddatum>
      <date>03/24/2014</date>
    </send_versanddatum>
    <send_gewichtgesamt>1.00</send_gewichtgesamt>
    <package collection="true">
      <collection_index>1</collection_index>
      <send_id>1Z7110966853336416</send_id>
      <send_gewichteinzel>1</send_gewichteinzel>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_code>Manifest Pickup</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>data_transmitted</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>12:39:40</time>
          <date>03/24/2014</date>
        </status_date>
        <status_details>Order Processed: Ready for UPS</status_details>
        <collection_index>1</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>HERFORD</status_city>
        <status_code>Pick-Up</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>pick_up</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>19:35:00</time>
          <date>03/24/2014</date>
        </status_date>
        <status_details>Origin Scan</status_details>
        <collection_index>2</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>HERFORD</status_city>
        <status_code>In transit</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>transit</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>23:00:00</time>
          <date>03/24/2014</date>
        </status_date>
        <status_details>Departure Scan</status_details>
        <collection_index>3</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>NURNBERG</status_city>
        <status_code>In transit</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>transit</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>05:54:00</time>
          <date>03/25/2014</date>
        </status_date>
        <status_details>Arrival Scan</status_details>
        <collection_index>4</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>NURNBERG</status_city>
        <status_code>In transit</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>transit</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>19:43:00</time>
          <date>03/25/2014</date>
        </status_date>
        <status_details>Departure Scan</status_details>
        <collection_index>5</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>OETZING</status_city>
        <status_code>In transit</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>transit</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>22:00:00</time>
          <date>03/25/2014</date>
        </status_date>
        <status_details>Arrival Scan</status_details>
        <collection_index>6</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>OETZING</status_city>
        <status_code>In transit</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>transit</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>09:27:00</time>
          <date>03/26/2014</date>
        </status_date>
        <status_details>Destination Scan</status_details>
        <collection_index>7</collection_index>
      </package_tracking_status>
      <package_tracking_status collection="true">
        <status_country>DE</status_country>
        <status_city>ARNSTORF</status_city>
        <status_zip>94424</status_zip>
        <status_recipient>MUELLER</status_recipient>
        <status_code>Delivered</status_code>
        <status_path collection="true">
          <collection_index>1</collection_index>
          <status_code>delivered</status_code>
        </status_path>
        <status_path_count>1</status_path_count>
        <status_date>
          <time>13:41:00</time>
          <date>03/26/2014</date>
        </status_date>
        <status_details>Package/Shipment delivered</status_details>
        <collection_index>8</collection_index>
      </package_tracking_status>
      <package_tracking_status_count>8</package_tracking_status_count>
    </package>
    <package_count>1</package_count>
    <shipment_tracking_id>1Z7110966853336416</shipment_tracking_id>
    <shipment_id>3a7b13db-b20a-45bd-8e05-575e1311f2fb</shipment_id>
    <shipment_tracking_status>
      <status_first_refresh_date>
        <time>12:39:40</time>
        <date>03/24/2014</date>
      </status_first_refresh_date>
      <status_last_refresh_date>
        <time>13:41:00</time>
        <date>03/26/2014</date>
      </status_last_refresh_date>
      <status_code>delivered</status_code>
      <status_date>
        <timezone>
          <name>UTC</name>
          <offset>+0000</offset>
        </timezone>
        <time>09:26:12</time>
        <date>08/01/2014</date>
      </status_date>
    </shipment_tracking_status>
    <collection_index>1</collection_index>
  </shipment>
  <shipment_count>1</shipment_count>
</workitem>


2.4.1    Status-Codes

Im zurückgelieferten Ergebnis sind sowohl Status-Werte auf Ebene der Sendung unter dem Schlüssel shipment.shipment_tracking_id.status_code zu finden, als auch auf der Ebene einzelner Pakete. Diese sind unter dem Schlüssel shipment.package.package_tracking_status.status_path zu finden. Die genannten Schlüssel enthalten von MHP normierte Status-Codes. Diese Status-Codes sind im Anhang in separaten Tabellen aufgelistet.

Der Status-Code, der unter dem shipment.package.package_tracking_status.status_code zu finden ist, ist der originale Status-Code der vom Frachtführer übermittelt wurde.

2.4.2    Minimal Felder

Das Ergebnis kann je nach vorhandenem Informationsvolumen mehr oder weniger Informationen enthalten. In der nachfolgenden Tabelle sind alle Felder mit einer Beschreibung aufgeführt die bei jeder Anfrage mindestens mitgesendet werden.

Feld

Beschreibung

shipment_tracking_id

Tracking-Sendungsnummer des Frachtführers.

shipment_id

Eindeutige Id der Sendung im Shiptrack.com System.

frachtfuehrer

Kürzel des Frachtführers, mit dem die Sendung befördert wird.

package.send_id

Tracking-Paketnummer des Frachtführers.

send_versanddatum

Datum an dem die Sendung versendet wurde.

2.4.3    Datumswerte

Datumswerte werden in den Sendungsdaten immer nach folgendem Schema dargestellt:

  <timezone>
    <name>UTC</name>
    <offset>+0000</offset>
  </timezone>
  <time>09:26:12</time>
  <date>08/01/2014</date>

Feld

Beschreibung

date

Datum im Format mm/dd/yyyy

time

Zeit im Format hh:mm:ss

timezone

Zeitzone. Optionales Feld. Wenn Feld nicht angegeben ist die Zeitzone unbekannt.

timezone.name

Name der Zeitzone

timezone.offset

Offset zur UTC Zeitzone


2.4.4    Optionale Felder

Nachfolgend sind optionale Felder aufgeführt die in der Antwort enthalten sind. Die einzelnen Ebenen werden mithilfe von Punkten getrennt.

2.4.4.1   Shipmentebene

Alle diese Felder befinden sich auf der Shipment-Ebene, weswegen diese nicht explizit angegeben wird.

Feld

Beschreibung

send_referenznr_1

Referenznummer 1

send_referenznr_2

Referenznummer 2

send_referenznr_3

Referenznummer 3

send_referenznr_4

Referenznummer 4

send_referenznr_5

Referenznummer 5

abs_adr_01

Absenderadresse 1

abs_adr_02

Absenderadresse 2

abs_adr_03

Absenderadresse 2

abs_strasse

Absenderstraße

abs_plz

Absenderpostleitzahl

abs_ort

Absenderort

abs_land

Absenderland

abs_land_kurz

Zweistelliges Absenderländerkürzel (ISO3166)

abs_region

Bundesland/Kanton des Absenders

abs_mail

Absendermail

abs_telefon

Absendertelefon

abs_telefax

Absenderfax

abs_loc

Standort des Absenders

empf_adr_01

Empfängeradresse 1

empf_adr_02

Empfängeradresse 2

empf_adr_03

Empfängeradresse 2

empf_strasse

Empfängerstraße

empf_hnr

Empfängerhausnummer

empf_plz

Empfängerpostleitzahl

empf_ort

Empfängerort

empf_land_kurz

Zweistelliges Empfängerländerkürzel (ISO3166)

empf_land

Empfängerland

empf_staat

Staat des Empfängers

empf_iso

ISO-Code des Empfängers

empf_nationalitaet

Nationalität des Empfängers

Empf_postfach

Postfach des Empfängers

empf_mail

Empfängermail

empf_tel

Empfängertelefon

empf_kdnr

Empfängerkundennummer

send_gewichtgesamt

Gewicht aller Pakete in der Sendung

shipment_tracking_url

Link auf eine gebuchte Portalseite mit Trackinginformationen

send_abholdatum

Abholdatum der Sendung

send_anz

Anzahl der Pakete in der Sendung

send_kundenkennung

ggf. besondere Kundennummer

send_termindatum

Auslieferungsfälligkeit

send_service_code

Code Zusatzinformationen zur Sendung

send_service_details

Zusatzinformationen zur Sendung

send_art_lademittel_01

Palette, Paket …

send_nachnahmebetrag

Nachnahmebetrag

send_nachnahmewaehrung

Nachnahmebetrag Währung

send_mandant

Mandant einer Sendung

send_service_code

Service code

send_service_details

Details zur Serviceart

send_customerservice

Freie Bezeichnung der Serviceart (z.B. Express, Overnight)

shipment_tags

Spezielle Key-Value Parameter (inbound, outbound b2b,b2c)

send_estimatedtimeofarrival

Voraussichtliche Lieferzeit

send_contractedtimeofarrival

Vertragliche Lieferzeit

send_versandart_kunde

Serviceart Versand

sourcesystem_shipmentid

Eindeutige ID der Sendung aus dem Vorsystem

2.4.4.2   Shipmentstatusebene

Alle diese Felder können sich auf der Shipment-Tracking-Status-Ebene befinden.

Feld

Beschreibung

status_date

Statusdatum

status_code

MHP-Statuscode

2.4.4.3   Packageebene

Alle diese Felder können sich auf der Package-Ebene befinden.

Feld

Beschreibung

send_referenznr_6

Referenznummer 6

send_referenznr_7

Referenznummer 7

send_referenznr_8

Referenznummer 8

send_referenznr_9

Referenznummer 9

send_referenznr_10

Referenznummer 10

send_anzahllademittel_01

Anzahl der Lademittel 01

send_anzahllademittel_02

Anzahl der Lademittel 02

send_anzahllademittel_03

Anzahl der Lademittel 03

send_anzahllademittel_04

Anzahl der Lademittel 04

send_artlademittel_01

Art des Lademittels 01

send_gewichteinzel

Gewicht des Pakets

send_hoehe

Höhe des Pakets

send_laenge

Länge des Pakets

send_breite

Breite des Pakets

send_versandart

Versandart des Pakets

send_zusatz

Zusätzliche Pakete

sourcesystem_packageid

Eindeutige ID des Pakets aus dem Vorsystem

2.4.4.4   Packagestatusebene

Alle diese Felder können sich ebenfalls auf der Package-Tracking-Status-Ebene befinden.

Feld

Beschreibung

status_date

Statusdatum

status_details

Statusdetails

status_code

Statuscode

status_path.status_code

MHP-Statuscode

status_recipient

Wer hat das Paket entgegengenommen

status_drop_location

Detail, wo z.B. das Paket abgelegt wurde

status_country

Statusland kurz

status_zip

Status Postleitzahl

status_city

Statusort

Status_state

Staat zum Status

status_street

Statusstraße

status_depot_name

Status-Depotname

status_additional_info

Zusatzinformationen zum Status

Status_loc

Standort zum Status

2.4.4.5   Dokumentebene

Diese Ebene befindet sich innerhalb der Shipment-Ebene.

Feld

Beschreibung

shipment_document_id

Eindeutige DokumentenId

shipment_document_status_type

Status des Dokuments. Derzeit mögliche Status:("ShipmentDocumentOnInternalStorageStatus",
"ShipmentDocumentOnExternalStorageStatus",
"ShipmentDocumentExistsStatus",
"ShipmentDocumentDownloadErrorStatus")

shipment_document_type

Dokumentart. Beispiele:

"PoD",
"CustomsDocument",
"Invoice",
"Misc",
"Waybill"

url

Eindeutiger Pfad zum Dokument

created

Erstellungsdatum des Dokuments in der Datenbank

shipment_document_originalname

Originalname des Dokuments, wenn vorhanden

mimetype

Dokumententyp (tif, gif, png, pdf ...)

size

Dokumentengröße in byte

shipment_document_description

Beschreibung des Dokuments

2.4.4.6   Incidentebene

Diese Ebene befindet sich innerhalb der Shipment-Ebene.

Feld

Beschreibung

name

Name der Definition, die gegriffen hat

definition

Guid zur Definition, die gegriffen hat

created

Erstellungsdatum des Incidents

2.4.4.7   Timingebene

Diese Ebene befindet sich innerhalb der Shipment-Ebene.

Feld

Beschreibung

type

Typ des Timings (ETA, GTA, FIX)

calculation_quality

Trefferqualität ETA (ContryToCountry → PlzToPlzWithServicedefinition)

source.label

Wer hat es erstellt oder berechnet (derzeit MHP oder Carrier)

source.service_definition_guidEindeutige Id der zugrundeliegenden Versandart
source.transit_times_guidEindeutige Id der zugrundeliegenden  Versandart
source.hours_added.hours_totalSumme der Tage aus hours_saturday, hours_sunday & hours_holiday
source.hours_added.hours_saturdayAnzahl der Samstage, die auf die Laufzeit drauf gerechnet wurden
source.hours_added.hours_sundayAnzahl der Sonntage, die auf die Laufzeit drauf gerechnet wurden
source.hours_added.hours_holidayAnzahl der Feiertage, die auf die Laufzeit drauf gerechnet wurden
creation_dateErstellungszeitpunkt der Berechnung
range.from_dateErrechneter Lieferzeitpunkt von (Datum + Uhrzeit)
range.to_dateErrechneter Lieferzeitpunkt bis (Datum + Uhrzeit)

3      Anhang

3.1    Mögliche Status-Codes auf Sendungs- und Paketebene

Nachfolgend sind die sämtliche Status-Codes aufgelistet, die auf Sendungs- und Paketebene verwendet werden.

Hauptstatus
Unterstatus
Beschreibung
data_transmitted
Daten wurden dem Frachtführer gemeldet
delay
Verzögerung
delaycar_damagedProbleme mit dem Fahrzeug (Defekt, Unfall)
delaycustomsZollabfertigung
delaydelivery_attemptEmpfänger nicht angetroffen/Mehrmalige Zustellversuche
delaygoods_receipt_closedWarenannahme/-ausgabe Geschlossen
delayholidayFerien, Feiertag, Wochenende
delayreroutingDie Sendung wird umgeleitet
delayresources_exceededZeitmangel/Platzmangel
delayshelvedLagerung wegen Ferien, Feiertagen, Empfänger- oder Versender Verfügung
delaystrikeStreik
delaytrafficVerkehr
delayweatherHöhere Gewalt, Wetter
delivered
Zugestellt
deliveredat_neighborBeim Nachbarn abgegeben
deliveredautoDeliveryDie Lieferung wurde automatisch auf "Ausgeliefert" gesetzt, da innerhalb von 48 Stunden nach Erhalt des Lieferstatus kein Fehlerstatus empfangen wurde.
deliveredcustomer_picked_upVom Kunden abgeholt
deliveredpicked_up_from_customsVom Kunden beim Zoll abgeholt.
delivereddefect_deliveredDefekt an Paketshop oder Empfänger ausgeliefert
deliveredpartiallyTeilweise ausgeliefert
deliveredstorage_locationAn vereinbartem Abgabeort hinterlegt
deliveredpo_box_depositIns Postfach hinterlegt
deny
Annahme verweigert
fault
Fehler
faultcanceledVom Versender storniert
faultdamagedSendung beschädigt (im Eingang)
faultdestroyedSendung wurde auf Anfrage zerstört. Trackingverlauf endet.
faultincompleteSendung unvollständig
faultmissingSendung fehlt (im Eingang)
faultmissing_documentsFehlende/ fehlerhafte Unterlagen
faultno_labelFehlendes/ fehlerhaftes Label
faultnot_allowedNicht zulässige Ware
faultreturnVom Frachtführer zurückgesendet
faultstolenSendung wurde gestohlen.
fault

wrong_address

Der Empfänger ist nicht unter der angegebenen Adresse bekannt.
faultreceiver_movedDer Empfänger ist aus-/umgezogen
information
Information
informationinserted_in_systemDie Sendung wurde in Shiptrack.com angelegt.
informationpod_availableMit Quittung
out_for_delivery
Sendung auf dem Weg zum Empfänger
pick_up
Sendung wurde beim Versender abgeholt
transit
In Bewegung
transitaccesspointIn Packstation/ Postfiliale/ Paketshop angekommen und zur Abholung bereit.
transitcustoms_outSendung wurde vom Zoll freigegeben.
transitdepot_inIm Depot angekommen
transitdepot_outDepot verlassen
undefined
Unbekannter Status

3.2    Frachtführerkürzel

Nachfolgend werden alle derzeit bekannten Frachtführerkürzel aufgelistet.

Kürzel

Frachtführer

ABCLOGISTIKABC-Logistik GmbH
AMMAMM Spedition
APAEXPRESSDHL Parcel Austria

DPDAT

DPD Österreich / Prime Time

ASR

DB Schenker Österreich

ATP

Österreichische Post (AG)

BDP

Belgische Post (Bpost)

BLM

Bleckmann Niederlande

BOOSBoos Logistik Service

BRT

Bartolini Italien 

BURSPEDBursped Speditions-G.m.b.H. & Co.
CAMCamion Transport AG.
CESCity Express Serbia
CHESchweizer Post Express

CHP

Schweizer Post (CH)

COLISSIMOColissimo FR
COUCoureon Logistics GmbH
CPLPlanzer Transport AG (Schweiz)
CTTCorreios de Portugal

DCH

Dachser Intelligent Logistics

DHCDHL Parcel Connect
DHLDHL Paket
DHBDHL Benelux
DHLEXPRESSDHL Express
DHMDHL Home Delivery 2-Mann-Handling
DHNDHL Parcel Netherland

DKS

Logwin Holding Aschaffenburg GmbH

DPB

Deutsche Post AG (DV-Freimachung von Briefsendungen)

DPD

Dynamic Parcel Distribution - Geopost

DPDUKDynamic Parcel Distribution United Kingdom
DSVDSV Air & Sea Germany GmbH
DSWSwipBox

DTL

Deutsche Textil Logistik

DZS

DHL Freight (Danzas)

EAKAzkar, Dachser Spanien

ECS

Correos ES . Public

EMS

Emons Spedition GmbH

ESR

SEUR (E)

ETSTIP SA Spain
FCPColis Privé
FCRChronopost Frankreich
FDEDelivengo

FDX

FedEx

FMRMondial Relay Distribution FR

FNT

TNT Express Frankreich

FPDDPD Frankreich
FRPLa Poste (FR)
FSRDB Schenker Frankreich
GEFCOGroupages express de Franche-Comté
GELExpress Logistik

GLS

General Logistic Systems

GLSFRGeneral Logistic Systems France
GLSHUGeneral Logistic Systems Hungary
GLSROGeneral Logistic Systems Romania
GLSSLGeneral Logistic Systems Slovenia

GON

General Overnight (GO!) Express & Logistics

GPC

Geis Parcel Slovakia CZ

GSMThe Delivery Group (Secured Mail)
GWWGebrüder Weiss Gesellschaft m.b.H.
HEPPNERSpedition Heppner

HES

Hermes 2 Man Handling

HVS

Hermes Versand Service

HWL

Hellmann Worldwide Logistics

IDSGEISHans Geis
IDSKUNKühne & Nagel
IDSSCHMIDSpedition Andreas Schmid Logistik AG
INNIGHTBENELUX
Nox Nachtexpress NL, BE
INNIGHTDEAT
Nox Nachtexpress DE, AT
INSIntersoft 

JENTSCH

Jentsch Logistik

KIA

Kiala

KNUBBENSpedition Knubben (OSL)
KIESSLINGSpedition Kiessling

KLEINE

Spedition Kleine

KOESTERHAPKEKöster & Hapke Internationale Spedition
LAGERMAXSpedition Lagermax
NBRBring Parcel Norway

NCT

Neutral Carrier Tracking (MHP)

NELLENQUACK

Nellen & Quack Spedition und Logistik

NGLGLS Netherlands
NOLIMITNo Limits Trans GmbH Polen
NOTHEGGERNothegger Transport Logistik GmbH

NSE

Night Star Express

NTGLOGISTICSNTG Logistik
NTSNational Transport Service GmbH
OETJENSpedition Oetjen
ONTIMEOntime Logistics

OPL

Opal

PDKPost Denmark
PHLDHL Parcel Poland

PON

Post Nord

QUEHENBERGERQuehenberger Logistics
PIPInpost Poland
PLP
Poczta Polska
PPLProfessional Parcel Logistic

RABEN

Raben Group

RHE

Rhenus Logistics

RUEDINGERRüdinger Spedition
SCHAEFSchäflein Spedition GmbH
SDG7Days Logistics
SEVENSENDERSSeven Senders GmbH
SKPSlovenská pošta

SKR

Schenker Deutschland AG

STRECKStreck Transport Spedition
SWLSkyNet Worldwide Express
TCSTCS Sterne

THIJS

Thijs Logistiek

TMD

Transmed Transportmanagement

TMLTM Logistik & Services

TNT

Thomas Nationwide Transport

TOF

Trans-o-flex

TPG

Post (Niederlande)

UKMDHL Parcel UK Mail

UPS

United Parcel Service

WLSWLS Spedition GmbH
YDLYodel Delivery Network Limited
ZOBELGebr. Zobel & Co. Speditions GmbH

UPS

United Parcel Service

WLSWLS Spedition GmbH
YDLYodel Delivery Network Limited
ZOBELGebr. Zobel & Co. Speditions GmbH
UKMDHL Parcel UK Mail

UPS

United Parcel Service

WLSWLS Spedition
ZOBELSpedition Zobel

3.4    WSDL

3.4.1    WSDL für Shipments

<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex" xmlns:i0="http://tempuri.org/" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsa10="http://www.w3.org/2005/08/addressing" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsap="http://schemas.xmlsoap.org/ws/2004/08/addressing/policy" xmlns:msc="http://schemas.microsoft.com/ws/2005/12/wsdl/contract" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://mhp-net.de/services/vinfo/shipments" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" name="Shipments" targetNamespace="http://mhp-net.de/services/vinfo/shipments">
	<wsdl:import namespace="http://tempuri.org/" location="https://service.shiptrack.com:8443/shipments?wsdl=wsdl0"/>
	<wsdl:types>
		<xsd:schema targetNamespace="http://mhp-net.de/services/vinfo/shipments/Imports">
			<xsd:import schemaLocation="https://service.shiptrack.com:8443/shipments?xsd=xsd0" namespace="http://mhp-net.de/services/vinfo/shipments"/>
			<xsd:import schemaLocation="https://service.shiptrack.com:8443/shipments?xsd=xsd1" namespace="http://schemas.microsoft.com/2003/10/Serialization/"/>
		</xsd:schema>
	</wsdl:types>
	<wsdl:message name="Shipments_Put_InputMessage">
		<wsdl:part name="parameters" element="tns:Put"/>
	</wsdl:message>
	<wsdl:message name="Shipments_Put_OutputMessage">
		<wsdl:part name="parameters" element="tns:PutResponse"/>
	</wsdl:message>
	<wsdl:message name="Shipments_Get_InputMessage">
		<wsdl:part name="parameters" element="tns:Get"/>
	</wsdl:message>
	<wsdl:message name="Shipments_Get_OutputMessage">
		<wsdl:part name="parameters" element="tns:GetResponse"/>
	</wsdl:message>
	<wsdl:portType name="Shipments">
		<wsdl:operation name="Put">
			<wsdl:input wsam:Action="http://mhp-net.de/services/vinfo/shipments/Shipments/Put" message="tns:Shipments_Put_InputMessage"/>
			<wsdl:output wsam:Action="http://mhp-net.de/services/vinfo/shipments/Shipments/PutResponse" message="tns:Shipments_Put_OutputMessage"/>
		</wsdl:operation>
		<wsdl:operation name="Get">
			<wsdl:input wsam:Action="http://mhp-net.de/services/vinfo/shipments/Shipments/Get" message="tns:Shipments_Get_InputMessage"/>
			<wsdl:output wsam:Action="http://mhp-net.de/services/vinfo/shipments/Shipments/GetResponse" message="tns:Shipments_Get_OutputMessage"/>
		</wsdl:operation>
	</wsdl:portType>
	<wsdl:service name="Shipments">
		<wsdl:port name="BasicHttpBinding_Shipments" binding="i0:BasicHttpBinding_Shipments">
			<soap:address location="https://service.shiptrack.com:8443/shipments"/>
		</wsdl:port>
	</wsdl:service>
</wsdl:definitions>

3.4.2    WSDL für ShipmentsSearch

<wsdl:definitions name="ShipmentsSearch" targetNamespace="http://mhp-net.de/services/vinfo/shipmentsSearch" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex" xmlns:wsap="http://schemas.xmlsoap.org/ws/2004/08/addressing/policy" xmlns:msc="http://schemas.microsoft.com/ws/2005/12/wsdl/contract" xmlns:i0="http://tempuri.org/" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://mhp-net.de/services/vinfo/shipmentsSearch" xmlns:wsa10="http://www.w3.org/2005/08/addressing" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
  <wsp:Policy wsu:Id="BasicHttpBinding_ShipmentsSearch_policy">
    <wsp:ExactlyOne>
      <wsp:All>
        <sp:TransportBinding xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
          <wsp:Policy>
            <sp:TransportToken>
              <wsp:Policy>
                <sp:HttpsToken RequireClientCertificate="false"/>
              </wsp:Policy>
            </sp:TransportToken>
            <sp:AlgorithmSuite>
              <wsp:Policy>
                <sp:Basic256/>
              </wsp:Policy>
            </sp:AlgorithmSuite>
            <sp:Layout>
              <wsp:Policy>
                <sp:Lax/>
              </wsp:Policy>
            </sp:Layout>
            <sp:IncludeTimestamp/>
          </wsp:Policy>
        </sp:TransportBinding>
        <sp:SignedSupportingTokens xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
          <wsp:Policy>
            <sp:UsernameToken sp:IncludeToken="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy/IncludeToken/AlwaysToRecipient">
              <wsp:Policy>
                <sp:WssUsernameToken10/>
              </wsp:Policy>
            </sp:UsernameToken>
          </wsp:Policy>
        </sp:SignedSupportingTokens>
        <sp:Wss10 xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
          <wsp:Policy/>
        </sp:Wss10>
      </wsp:All>
    </wsp:ExactlyOne>
  </wsp:Policy>
  <wsdl:types>
    <xs:schema elementFormDefault="qualified" targetNamespace="http://mhp-net.de/services/vinfo/shipmentsSearch" xmlns:xs="http://www.w3.org/2001/XMLSchema">
      <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/"/>
      <xs:element name="GetWithTrackingNr">
        <xs:complexType>
          <xs:sequence>
            <xs:element minOccurs="0" name="client" type="q1:guid" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/"/>
            <xs:element minOccurs="0" name="trackingNr" nillable="true" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="GetWithTrackingNrResponse">
        <xs:complexType>
          <xs:sequence>
            <xs:element minOccurs="0" name="GetWithTrackingNrResult" nillable="true" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="GetWithReferenceNr">
        <xs:complexType>
          <xs:sequence>
            <xs:element minOccurs="0" name="client" type="q2:guid" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/"/>
            <xs:element minOccurs="0" name="referenceNr" nillable="true" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="GetWithReferenceNrResponse">
        <xs:complexType>
          <xs:sequence>
            <xs:element minOccurs="0" name="GetWithReferenceNrResult" nillable="true" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:schema>
    <xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/">
      <xs:element name="anyType" nillable="true" type="xs:anyType"/>
      <xs:element name="anyURI" nillable="true" type="xs:anyURI"/>
      <xs:element name="base64Binary" nillable="true" type="xs:base64Binary"/>
      <xs:element name="boolean" nillable="true" type="xs:boolean"/>
      <xs:element name="byte" nillable="true" type="xs:byte"/>
      <xs:element name="dateTime" nillable="true" type="xs:dateTime"/>
      <xs:element name="decimal" nillable="true" type="xs:decimal"/>
      <xs:element name="double" nillable="true" type="xs:double"/>
      <xs:element name="float" nillable="true" type="xs:float"/>
      <xs:element name="int" nillable="true" type="xs:int"/>
      <xs:element name="long" nillable="true" type="xs:long"/>
      <xs:element name="QName" nillable="true" type="xs:QName"/>
      <xs:element name="short" nillable="true" type="xs:short"/>
      <xs:element name="string" nillable="true" type="xs:string"/>
      <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte"/>
      <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt"/>
      <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong"/>
      <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort"/>
      <xs:element name="char" nillable="true" type="tns:char"/>
      <xs:simpleType name="char">
        <xs:restriction base="xs:int"/>
      </xs:simpleType>
      <xs:element name="duration" nillable="true" type="tns:duration"/>
      <xs:simpleType name="duration">
        <xs:restriction base="xs:duration">
          <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?"/>
          <xs:minInclusive value="-P10675199DT2H48M5.4775808S"/>
          <xs:maxInclusive value="P10675199DT2H48M5.4775807S"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:element name="guid" nillable="true" type="tns:guid"/>
      <xs:simpleType name="guid">
        <xs:restriction base="xs:string">
          <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}"/>
        </xs:restriction>
      </xs:simpleType>
      <xs:attribute name="FactoryType" type="xs:QName"/>
      <xs:attribute name="Id" type="xs:ID"/>
      <xs:attribute name="Ref" type="xs:IDREF"/>
    </xs:schema>
  </wsdl:types>
  <wsdl:message name="ShipmentsSearch_GetWithTrackingNr_InputMessage">
    <wsdl:part name="parameters" element="tns:GetWithTrackingNr"/>
  </wsdl:message>
  <wsdl:message name="ShipmentsSearch_GetWithTrackingNr_OutputMessage">
    <wsdl:part name="parameters" element="tns:GetWithTrackingNrResponse"/>
  </wsdl:message>
  <wsdl:message name="ShipmentsSearch_GetWithReferenceNr_InputMessage">
    <wsdl:part name="parameters" element="tns:GetWithReferenceNr"/>
  </wsdl:message>
  <wsdl:message name="ShipmentsSearch_GetWithReferenceNr_OutputMessage">
    <wsdl:part name="parameters" element="tns:GetWithReferenceNrResponse"/>
  </wsdl:message>
  <wsdl:portType name="ShipmentsSearch">
    <wsdl:operation name="GetWithTrackingNr">
      <wsdl:input wsam:Action="http://mhp-net.de/services/vinfo/shipmentsSearch/ShipmentsSearch/GetWithTrackingNr" mes-sage="tns:ShipmentsSearch_GetWithTrackingNr_InputMessage"/>
      <wsdl:output wsam:Action="http://mhp-net.de/services/vinfo/shipmentsSearch/ShipmentsSearch/GetWithTrackingNrResponse" message="tns:ShipmentsSearch_GetWithTrackingNr_OutputMessage"/>
    </wsdl:operation>
    <wsdl:operation name="GetWithReferenceNr">
      <wsdl:input wsam:Action="http://mhp-net.de/services/vinfo/shipmentsSearch/ShipmentsSearch/GetWithReferenceNr" mes-sage="tns:ShipmentsSearch_GetWithReferenceNr_InputMessage"/>
      <wsdl:output wsam:Action="http://mhp-net.de/services/vinfo/shipmentsSearch/ShipmentsSearch/GetWithReferenceNrResponse" message="tns:ShipmentsSearch_GetWithReferenceNr_OutputMessage"/>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="BasicHttpBinding_ShipmentsSearch" type="tns:ShipmentsSearch">
    <wsp:PolicyReference URI="#BasicHttpBinding_ShipmentsSearch_policy"/>
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="GetWithTrackingNr">
      <soap:operation soapAction="http://mhp-net.de/services/vinfo/shipmentsSearch/ShipmentsSearch/GetWithTrackingNr" style="document"/>
      <wsdl:input>
        <soap:body use="literal"/>
      </wsdl:input>
      <wsdl:output>
        <soap:body use="literal"/>
      </wsdl:output>
    </wsdl:operation>
    <wsdl:operation name="GetWithReferenceNr">
      <soap:operation soapAction="http://mhp-net.de/services/vinfo/shipmentsSearch/ShipmentsSearch/GetWithReferenceNr" style="document"/>
      <wsdl:input>
        <soap:body use="literal"/>
      </wsdl:input>
      <wsdl:output>
        <soap:body use="literal"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="ShipmentsSearch">
    <wsdl:port name="BasicHttpBinding_ShipmentsSearch" bind-ing="tns:BasicHttpBinding_ShipmentsSearch">
      <soap:address loca-tion="https://service.shiptrack.com:8443/shipmentssearch"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>