shiptrack.com REST Schnittstelle - deutsch

1      Allgemein

1.1    Änderungshistorie

Rev. NrDatumFirmaMitarbeiterBeschreibung der Änderung

1.0

16.09.2015

MHP

ML

Erstellung des Dokuments

1.1

11.01.2016

MHP

ML

Aufnahme der URL für das Testsystem und Beschreibung der einzelnen Datenebenen hinzugefügt

1.2

19.02.2016

MHP

ML

Ergänzung der minimalen Felder für die Sammelabfrage

1.3

02.06.2016

MHP

ML

PUT aus der Sammelabfrage entfernt und

Anpassungen an den Frachtführerkürzeln

1.4

22.06.2016

MHP

MWi

Anpassungen des Verweises der minimalen Felder auf Kapitel 2.3.2

1.5

13.09.2016

MHP

LK

Ergänzung fehlender Frachtführerkürzel

1.6

11.10.2016

MHP

ML

Referenzen umbenannt, Beschreibungen ergänzt

1.7

31.05.2017

MHP

ML

Parameter send_customerservice eingeführt

1.8

13.06.2017

MHP

LRS

Hinzufügen weiterer Parameter

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.407.02.2018MHPMLZusätzliche Objekte wie Dokumente, Incidents und Timings
1.8.504.08.2020MHPRSUpdate Frachtführerkürzel
1.8.609.04.2021MHPMWiAktualisierung übermittelter Felder
1.8.715.04.2021MHPMLNeues Feld empf_locale für die Sprache des Empfängers
1.8.808.07.2021MHPRSErgänzung fehlender Frachtführerkürzel
1.8.912.08.2021MHPMWiEntfernung des onlyUpdates parameter
1.8.9.127.09.2021MHPMWiFrachtführerkürzel AMM hinzugefügt

1.2    Einführung

Nachfolgend wird die Schnittstelle beschrieben, die der Shiptrack.com Service anbietet. Die Schnittstelle ist in mehrere URL-Endpunkte nach dem REST Paradigma aufgeteilt. Mithilfe jedes URL-Endpunktes kann eine spezifische Ressource bearbeitet oder abgefragt werden. Sämtliche Abfragen erfolgen per HTTPS. Dabei müssen die in der folgenden Tabelle angegebenen HTTP-Header mit den aufgeführten Werten gesetzt werden. Die Authentifizierung des Aufrufers, erfolgt an der Schnittstelle mithilfe eines zuvor definierten Benutzernamens und Passworts über die HTTP-Basic Authentifizierungsmethode (siehe RFC2617).


HTTP-Header

Wert

Content-Type

application/json

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:


{
       "Message": "Requested client does not exists"
       "ErrorCode" : "404.1"
}


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

Zum Abruf der Sendungsverfolgungsdaten existieren zwei unterschiedliche Methoden. Die erste Methode ist die Sammelabfrage. Mit dieser können große Datenmenge zwischen zwei Systemen übertragen werden, dabei existiert ein Mechanismus um nur aktualisierte Daten seit dem letzten Abruf zu übertragen. Des Weiteren ist es möglich über diese Methode neue Sendungen oder zusätzliche Informationen für Sendungen an Shiptrack.com zu senden. Als zweite Methode steht die Einzelabfrage zur Verfügung mit der einzelne Sendungen abgefragt werden können. Nachfolgend werden die beiden Methode genauer Erläutert.

2.1    Sammelabfrage

URL Livesystem: https://service.shiptrack.com/clients/<Client-Id>/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 JSON-String 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/clients/<Client-Id>/shipmentsSearch

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

2.2.1    GET

Mit dem GET-Verb kann eine Suche auf den Sendungsdaten durchgeführt werden. Dabei wird der jeweilige Suchparameter als GET-Parameter der Anfrage übergeben. Eine Kombination von mehreren Suchparametern ist noch vorhergesehen und führt zu einem leeren Ergebnis. Folgende Suchparameter stehen zur Verfügung:

  • trackingNr 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
    Datentyp:
    string
  • referenceNr Dieser Parameter 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.
    Datentyp:
    string

2.3    Sendungsanlage

2.3.1    PUT

Mit dem http-Verb PUT können eine oder mehrere Sendungen an den Service übermittelt werden. Bei erfolgreicher Annahme der Anfrage wird nur ein HTTP Status-Code 202 zurückgemeldet. Zur erfolgreichen Übermittlung müssen die Minimalfelder die in Abschnitt 2.3.2 angegeben werden gefüllt sein.

Nach erfolgreicher Übermittlung stehen die Daten nicht sofort zum Abruf über die Sammel- oder Einzelabfrage zur Verfügung sondern müssen erst durch den Service verarbeitet werden.

Falls Sie größere Blöcke übertragen möchten, sprechen Sie uns bitte an, damit wir den Import darauf optimieren können! Eine Blockgröße von mehr als 10 Sendungen ist nicht ratsam.

2.3.2    Minimale Felder für Anlage einer neuen Sendung

Feld

Beschreibung

shipment_tracking_id

Tracking-Sendungsnummer des Frachtführers. (Ist nicht über längeren Zeitraum eindeutig)

frachtfuehrer

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

package.send_id

Tracking-Paketnummer des Frachtführers.

(Wenn keine abweichende Paketnummer vorhanden ist, dann ist die Sendungsnummer als Paketnummer anzulegen!)

package.send_referenzid

(Nur Pflicht beim Frachtführer DPB (Deutsch Post))

RFID für den Ländernachweis.

(Wenn keine abweichende Paketnummer vorhanden ist, dann ist die Sendungsnummer und die Paketnummer wie RFID anzulegen!)

send_versanddatum

Datum an dem die Sendung versendet wurde.

2.3.3   Beispiel die für Anlage einer einzelnen neuen Sendung

{

  "shipment": [

    {

      "shipment_tracking_id": "123456789",

      "frachtfuehrer": "DHL",

      "send_versanddatum": {

        "time": "12:00:00",

        "date": "01/01/2016"

      },

      "package": [{

          "send_id": "123456789",

          "send_referenzid": "AV123456789DE"

        }]

    }

  ]

}

2.3.4    Zusatzparameter

Zur Unterscheidung der auszuführenden Workflows kann ein weiterer Headerparameter mitgegeben werden:

  • source Wird dieser Parameter angegeben (nach Absprache mit der MHP), werden alle gelieferten Sendungen einem bestimmten Workflow zugeführt.
    Datentyp:
    string

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 JSON-Format statt. Dabei wird immer ein Dokument, welches ein Array an Sendungen enthält, übermittelt. Somit wird mindestens folgende Nachricht übertragen:

{
       „shipment“ : [ ],
       „shipment_count“ : "0"
}


Eine Abfrage die Daten enthält sieht wie folgt aus:


{
  "shipment": [
    {
      "frachtfuehrer": "UPS",
      "abs_adr_01": "MHP SOFTWARE GMBH",
      "abs_strasse": "JUSTUS-VON-LIEBIG-STRASSE 3",
      "abs_ort": "NEUSTADT A. RBGE.",
      "abs_plz": "31535",
      "abs_land_kurz": "DE",
      "empf_adr_01": "SPIELE SACHEN GMBH",
      "empf_adr_02": "z.Hd. Hans Grube",
      "empf_strasse": "TOY-STRASSE 3",
      "empf_ort": "OBER-MOERLEN",
      "empf_plz": "61239",
      "empf_land_kurz": "DE",
      "empf_locale": "de-DE", 
      "send_referenznr_01": "ls11500197",
      "send_abholdatum": {
        "date": "10/08/2015"
      },
      "send_versanddatum": {
        "date": "10/08/2015"
      },
      "send_gewichtgesamt": "20.00",
      "package": [
        {
          "collection_index": "1",
          "send_id": "1Z041R9A6870044607",
          "send_gewichteinzel": "10",
          "send_nr": "1",
          "send_hoehe": "0",
          "send_laenge": "0",
          "send_breite": "0",
          "send_versandart": "512",
          "send_2n_prodcode": "8398865",
          "send_ident_prodcode_01": "0",
          "send_ident_prodcode_02": "0",
          "package_tracking_status": [
            {
              "status_country": "DE",
              "status_code": "Manifest Pickup",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "data_transmitted"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "09:09:04",
                "date": "10/08/2015"
              },
              "status_details": "Order Processed: Ready for UPS",
              "collection_index": "1"
            },
            {
              "status_country": "DE",
              "status_city": "LANGENHAGEN",
              "status_code": "Pick-Up",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "pick_up"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "20:54:59",
                "date": "10/08/2015"
              },
              "status_details": "Origin Scan",
              "collection_index": "2"
            },
            {
              "status_country": "DE",
              "status_city": "LANGENHAGEN",
              "status_code": "In transit",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "transit"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "20:55:00",
                "date": "10/08/2015"
              },
              "status_details": "Origin Scan",
              "collection_index": "3"
            },
            {
              "status_country": "DE",
              "status_city": "OFFENBACH",
              "status_zip": "63073",
              "status_recipient": "SAHIN",
              "status_code": "Delivered",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "delivered"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "09:42:00",
                "date": "10/09/2015"
              },
              "status_details": "Delivered",
              "collection_index": "7"
            }
          ],
          "package_tracking_status_count": "7"
        },
        {
          "collection_index": "2",
          "send_id": "1Z041R9A6870044616",
          "send_gewichteinzel": "10",
          "send_nr": "2",
          "send_hoehe": "0",
          "send_laenge": "0",
          "send_breite": "0",
          "send_versandart": "512",
          "send_2n_prodcode": "8398865",
          "send_ident_prodcode_01": "0",
          "send_ident_prodcode_02": "0",
          "send_customerservice": "Overnight 12:00",
          "package_tracking_status": [
            {
              "status_country": "DE",
              "status_code": "Manifest Pickup",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "data_transmitted"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "09:09:04",
                "date": "10/08/2015"
              },
              "status_details": "Order Processed: Ready for UPS",
              "collection_index": "1"
            },
            {
              "status_country": "DE",
              "status_city": "LANGENHAGEN",
              "status_code": "Pick-Up",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "pick_up"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "21:00:59",
                "date": "10/08/2015"
              },
              "status_details": "Origin Scan",
              "collection_index": "2"
            },
            {
              "status_country": "DE",
              "status_city": "LANGENHAGEN",
              "status_code": "In transit",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "transit"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "21:01:00",
                "date": "10/08/2015"
              },
              "status_details": "Origin Scan",
              "collection_index": "3"
            },
            {
              "status_country": "DE",
              "status_city": "OFFENBACH",
              "status_zip": "63073",
              "status_recipient": "SAHIN",
              "status_code": "Delivered",
              "status_path": [
                {
                  "collection_index": "1",
                  "status_code": "delivered"
                }
              ],
              "status_path_count": "1",
              "status_date": {
                "time": "09:42:00",
                "date": "10/09/2015"
              },
              "status_details": "Delivered",
              "collection_index": "8"
            }
          ],
          "package_tracking_status_count": "8"
        }
      ],
      "package_count": "2",
      "send_referenznr_02": "D05865",
      "send_anz": "2",
      "empf_tel": "069 175 3637 0",
      "collection_index": "1",
      "shipment_tracking_id": "1Z041R9A6870044607",
      "shipment_id": "3aadea46-75ac-4a85-a586-6476febce759",
      "shipment_tracking_url": "https://portal.shiptrack.com/tracking/2aadea4675ac2a85a5866476febce752",
      "incidents": [
        {
          "name": "Lead Time Exceeded",
          "definition": "00000000-0000-0000-0000-000000000000",
          "created": {
            "timezone": {
              "name": "UTC",
              "offset": "+0000"
            },
            "time": "13:59:25",
            "date": "10/31/2013"
          },
          "collection_index": "1"
        }
      ],
      "incidents_count": "1",
      "timings": [
        {
          "type": "ETA",
          "calculation_quality": "90",
          "source": {
            "label": "MHP",
            "service_definition_guid": "00000000-0000-0000-0000-000000000000",
            "transit_times_guid": "00000000-0000-0000-0000-000000000000",
            "hours_added": {
              "hours_total": "00:00:00",
              "hours_saturday": "00:00:00",
              "hours_sunday": "00:00:00",
              "hours_holiday": "00:00:00"
            }
          },
          "creation_date": {
            "time": "13:59:25",
            "date": "10/31/2013"
          },
          "range": {
            "from_date": {
              "time": "16:00:00",
              "date": "10/31/2013"
            },
            "to_date": {
              "time": "18:00:00",
              "date": "10/31/2013"
            }
          },
          "collection_index": "1"
        }
      ],
      "timings_count": "1",
      "shipment_tracking_status": {
        "status_first_refresh_date": {
          "time": "09:09:04",
          "date": "10/08/2015"
        },
        "status_last_refresh_date": {
          "time": "09:42:00",
          "date": "10/09/2015"
        },
        "status_code": "delivered",
        "status_date": {
          "timezone": {
            "name": "UTC",
            "offset": "+0000"
          },
          "time": "09:16:56",
          "date": "10/12/2015"
        }
      },
      "configurations": [
        {
          "id": "76e457fc-1c5f-4981-9b24-53dd31e335ef",
          "last_change": {
            "timezone": {
              "name": "UTC",
              "offset": "+0000"
            },
            "time": "15:39:02",
            "date": "10/08/2015"
          },
          "collection_index": "1"
        },
        {
          "id": "76e457fc-1c5f-4981-9b24-53dd31e335ef",
          "last_change": {
            "timezone": {
              "name": "UTC",
              "offset": "+0000"
            },
            "time": "09:19:36",
            "date": "10/09/2015"
          },
          "collection_index": "2"
        }
      ],
      "configurations_count": "2",
      "shipment_documents": [
        {
          "shipment_document_status_type": "ShipmentDocumentOnInternalStorageStatus",
          "shipment_document_type": "PoD",
          "shipment_document_id": "00000000-0000-0000-0000-000000000000",
          "created": {
            "time": "12:59:25",
            "date": "10/31/2013"
          },
          "url": "https://document.shiptrack.com/00000000-0000-0000-0000-000000000000",
          "mimetype": "application/xml",
          "size": "10180",
          "shipment_document_originalname": "1Z578873QH70008601_8d51128e-03e1-4b81-a55a-727734d00225.gif",
          "collection_index": "1"
        }
      ],
      "shipment_documents_count": "1",
      "shipment_tags": [],
      "shipment_tags_count": "0",
      "status_tags": [
        {
          "status_code": "delivered",
          "collection_index": "1"
        }
      ],
      "status_tags_count": "1"
    }
  ],
  "shipment_count": "1"
}

2.4.1    Format der Shipmenttags

"shipment_tags": [

    {

      "collection_index": "1",

      "tag": "outbound"

    },

    {

      "collection_index": "2",

      "tag": "b2b"

    }

  ]

Im nachfolgenden werden Angaben für Felder auf die einzelnen Ebenen im JSON durch einen Pfad mit Punkten getrennt angegeben. Zum Beispiel wird auf das Feld send_id, welches sich auf der Pakete-Ebene, die sich wiederum auf der Shipment-Ebene befindet, wie folgt angegeben: shipment.package.send_id


2.4.2    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.3    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. Alle Felder befinden sich mindestens auf der Shipment-Ebene, weswegen diese nicht explizit angegeben wird.


Feld

Beschreibung

shipment_tracking_id

Tracking-Sendungsnummer des Frachtführers. (Ist nicht über längeren Zeitraum eindeutig)

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.4    Datumswerte

Datumswerte werden in den Sendungsdaten immer nach folgendem Schema dargestellt:


{

   "timezone": {

      "name": "UTC",

      "offset": "+0000"

   },

   "time": "08:49:08",

   "date": "07/03/2013"

}


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.5   Optionale Felder

Nachfolgend sind optionale Felder aufgeführt die in der Antwort enthalten seien können.

2.4.5.1   Shipmentebene

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

Feld

Beschreibung

send_referenznr_01

Referenznummer 1

send_referenznr_02

Referenznummer 2

send_referenznr_03

Referenznummer 3

send_referenznr_04

Referenznummer 4

send_referenznr_05

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_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_unterschrift

Empfängerunterschrift

empf_mail

Empfängermail

empf_tel

Empfängertelefon

empf_kdnr

Empfängerkundennummer

empf_localeSprache des Empfängers (aktuell mögliche Werte: af-ZA, am-ET, be-BY, bg-BG, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AU, en-CA, en-GB, en-IE, en-NZ, en-US, es-ES, et-EE, eu-ES, fi-FI, fr-BE, fr-CA, fr-CH, fr-FR, he-IL, hi-IN, hr-HR, hy-AM, is-IS, it-CH, it-IT, ja-JP, kk-KZ, ko-KR, la-LN, lt-LT, nl-BE, nl-NL, no-NO, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sk-SK, sl-SI, sr-YU, sv-SE, tr-TR, uk-UA, zh-CN, zh-HK, zh-TW)

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_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.5.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.5.3   Packageebene

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

Feld

Beschreibung

send_referenznr_06

Referenznummer 6

send_referenznr_07

Referenznummer 7

send_referenznr_08

Referenznummer 8

send_referenznr_09

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.5.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.5.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.5.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.5.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.

Main status

Sub status

Description (en)

Description (de)

data_transmitted

Parcel data has been transmitted

Daten wurden dem Frachtführer gemeldet

delay

Delayed

Verzögerung

delay

car_damaged

Vehicle damaged

Probleme mit dem Fahrzeug (Defekt, Unfall)

delay

customs

Parcel has been checked by customs

Zollabfertigung

delay

delivery_attempt

Delivery attempt

Empfänger nicht angetroffen/Mehrmalige Zustellversuche

delay

goods_receipt_closed

Goods department closed

Warenannahme/-ausgabe Geschlossen

delay

holiday

Holiday

Ferien, Feiertag, Wochenende

delay

rerouting

Rerouting

Die Sendung wird umgeleitet

delay

resources_exceeded

Resources exceeded (time, space,...)

Zeitmangel/Platzmangel

delay

shelved

Shelved, based on holiday or customers request

Lagerung wegen Ferien, Feiertagen, Empfänger- oder Versender Verfügung

delay

strike

Strike

Streik

delay

traffic

Traffic

Verkehr

delay

weather

Force majeure

Höhere Gewalt, Wetter

delivered

Parcel has been delivered

Zugestellt

delivered

at_neighbor

Delivered to a neighbor

Beim Nachbarn abgegeben

delivered

autoDelivery

The delivery was automatically set to "Delivered" because no error status was received within 48 hours of receiving the delivery status

Die Lieferung wurde automatisch auf "Ausgeliefert" gesetzt, da innerhalb von 48 Stunden nach Erhalt des Lieferstatus kein Fehlerstatus empfangen wurde.

delivered

customer_picked_up

Picked up by the customer

Vom Kunden abgeholt

delivered

picked_up_from_customs

Picked up by the customer at customs

Vom Kunden beim Zoll abgeholt.

delivered

defect_delivered

Defective delivered to the parcel shop or recipient

Defekt an Paketshop oder Empfänger ausgeliefert

delivered

partially

Partially delivered

Teilweise ausgeliefert

delivered

storage_location

Stored at the agreed storage location

An vereinbartem Abgabeort hinterlegt

delivered

po_box_deposit

Stored in the PO box

Ins Postfach hinterlegt

deny

Package refused

Annahme verweigert

fault

Error

Fehler

fault

canceled

Canceled by the sender

Vom Versender storniert

fault

damaged

Shipment was damaged

Sendung beschädigt (im Eingang)

fault

destroyed

The consignment was destroyed on request. Tracking process ends

Sendung wurde auf Anfrage zerstört. Trackingverlauf endet.

fault

incomplete

Shipment is incomplete

Sendung unvollständig

fault

missing

Shipment missing

Sendung fehlt (im Eingang)

fault

missing_documents

Missing, faulty documents

Fehlende/ fehlerhafte Unterlagen

fault

no_label

Missing, faulty label

Fehlendes/ fehlerhaftes Label

fault

not_allowed

Prohibited goods

Nicht zulässige Ware

fault

return

Sent back by the carrier

Vom Frachtführer zurückgesendet

fault

stolen

Consignment was stolen

Sendung wurde gestohlen.

fault

wrong_address

The recipient is not known at the given address

Der Empfänger ist nicht unter der angegebenen Adresse bekannt.

fault

receiver_moved

The recipient moved

Der Empfänger ist aus-/umgezogen

information

information

Information

information

inserted_in_system

The shipment was added to Shiptrack.com

Die Sendung wurde in Shiptrack.com angelegt.

information

pod_available

Receipt added

Mit Quittung

out_for_delivery

Consignment on the way to the recipient

Sendung auf dem Weg zum Empfänger

pick_up

Shipment was picked up at the recipient

Sendung wurde beim Versender abgeholt

transit

In transit

In Bewegung

transit

accesspoint

Arrived at the packing station / post office / parcel shop and ready for collection

In Packstation/ Postfiliale/ Paketshop angekommen und zur Abholung bereit.

transit

customs_out

The shipment has been released by customs

Sendung wurde vom Zoll freigegeben.

transit

depot_in

Arrived at the depot

Im Depot angekommen

transit

depot_out

Left the depot

Depot verlassen

undefined

Unknown status

Unbekannter Status


3.2    Frachtführerkürzel

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

Shortcut

Carrier name

ABCLOGISTIK

ABC-Logistik GmbH

AMM

AMM Spedition

APAEXPRESS

DHL Parcel Austria

DPDAT

DPD Österreich / Prime Time

ASR

DB Schenker Österreich

ATP

Österreichische Post (AG)

BDP

Belgische Post (Bpost)

BLM

Bleckmann Niederlande

BOOS

Boos Logistik Service

BRT

Bartolini Italien 

BURSPED

Bursped Speditions-G.m.b.H. & Co.

CAM

Camion Transport AG.

CES

City Express Serbia

CHE

Schweizer Post Express

CHP

Schweizer Post (CH)

COLISSIMO

Colissimo FR

COU

Coureon Logistics GmbH

CPL

Planzer Transport AG (Schweiz)

CTT

Correios de Portugal

CQP

Quickpac

DAO

Dansk Avis Omdeling

DCH

Dachser Intelligent Logistics

DHC

DHL Parcel Connect

DHL

DHL Paket

DHB

DHL Benelux

DHLEXPRESS

DHL Express

DHM

DHL Home Delivery 2-Mann-Handling

DHN

DHL Parcel Netherland

DKS

Logwin Holding Aschaffenburg GmbH

DPB

Deutsche Post AG (DV-Freimachung von Briefsendungen)

DPD

Dynamic Parcel Distribution - Geopost

DPDUK

Dynamic Parcel Distribution United Kingdom

DSV

DSV Air & Sea Germany GmbH

DSW

SwipBox

DTL

Deutsche Textil Logistik

DZS

DHL Freight (Danzas)

EAK

Azkar, Dachser Spanien

ECS

Correos ES . Public

EMS

Emons Spedition GmbH

ESR

SEUR (E)

ETS

TIP SA Spain

FCP

Colis Privé

FCR

Chronopost Frankreich

FDE

Delivengo

FDX

FedEx

FMR

Mondial Relay Distribution FR

FNT

TNT Express Frankreich

FPD

DPD Frankreich

FRP

La Poste (FR)

FSR

DB Schenker Frankreich

GEFCO

Groupages express de Franche-Comté

GEL

Express Logistik

GLS

General Logistic Systems

GLSFR

General Logistic Systems France

GLSHU

General Logistic Systems Hungary

GLSRO

General Logistic Systems Romania

GLSSL

General Logistic Systems Slovenia

GON

General Overnight (GO!) Express & Logistics

GPC

Geis Parcel Slovakia CZ

GSM

The Delivery Group (Secured Mail)

GWW

Gebrüder Weiss Gesellschaft m.b.H.

HEPPNER

Spedition Heppner

HES

Hermes 2 Man Handling

HVS

Hermes Versand Service

HWL

Hellmann Worldwide Logistics

IDSGEIS

Hans Geis

IDSKUN

Kühne & Nagel

IDSSCHMID

Spedition Andreas Schmid Logistik AG

INNIGHTBENELUX

Nox Nachtexpress NL, BE

INNIGHTDEAT

Nox Nachtexpress DE, AT

INS

Intersoft 

JENTSCH

Jentsch Logistik

KIA

Kiala

KNUBBEN

Spedition Knubben (OSL)

KIESSLING

Spedition Kiessling

KLEINE

Spedition Kleine

KOEHA

Köster & Hapke Internationale Spedition

LAGERMAX

Spedition Lagermax

NBR

Bring Parcel Norway

NCT

Neutral Carrier Tracking (MHP)

NELLENQUACK

Nellen & Quack Spedition und Logistik

NGL

GLS Netherlands

NOLIMIT

No Limits Trans GmbH Polen

NOTHEGGER

Nothegger Transport Logistik GmbH

NSE

Night Star Express

NTGLOGISTICS

NTG Logistik

NTS

National Transport Service GmbH

OETJEN

Spedition Oetjen

ONTIME

Ontime Logistics

OPL

Opal

PDK

Post Denmark

PHL

DHL Parcel Poland

PON

Post Nord

QUEHENBERGER

Quehenberger Logistics

PIP

Inpost Poland

PLP

Poczta Polska

PPL

Professional Parcel Logistic

RABEN

Raben Group

RHE

Rhenus Logistics

RUEDINGER

Rüdinger Spedition

SCHAEF

Schäflein Spedition GmbH

SDG

7Days Logistics

SEVENSENDERS

Seven Senders GmbH

SKP

Slovenská pošta

SKR

Schenker Deutschland AG

STRECK

Streck Transport Spedition

SWL

SkyNet Worldwide Express

TCS

TCS Sterne

THIJS

Thijs Logistiek

TMD

Transmed Transportmanagement

TML

TM Logistik & Services

TNT

Thomas Nationwide Transport

TOF

Trans-o-flex

TPG

Post (Niederlande)

UKM

DHL Parcel UK Mail

UPS

United Parcel Service

WLS

WLS Spedition GmbH

YDL

Yodel Delivery Network Limited

ZOBEL

Gebr. Zobel & Co. Speditions GmbH