1 Allgemein

1.1 Einführung

Nachfolgend finden Sie eine Beschreibung der Schnittstelle, die der Shiptrack.com-Dienst bietet. Alle Abfragen erfolgen über HTTPS. Die in der folgenden Tabelle aufgeführten HTTP-Header müssen mit den aufgeführten Werten festgelegt werden. Der Anrufer wird an der Schnittstelle mit einem zuvor definierten Benutzernamen und Passwort unter Verwendung der HTTP Basic Authentication Method (siehe RFC2617) authentifiziert.

HTTP-Header	Value
Content-Type	application/json

1.3 Fehlerbehandlung

Um sicherzustellen, dass der Aufrufer eine aussagekräftige Fehlermeldung erhält, wenn ein Fehler in der Schnittstelle auftritt, sendet die Schnittstelle eine Antwort mit einem HTTP-Statuscode, der den Fehler darstellt. Außerdem wird eine Nachricht zurückgegeben, die detaillierte Informationen zum Fehler enthält. Beispielsweise wird für den Fehler, dass die Kundenummer, welche in der URL verwendet wurde, nicht existiert, der HTTP-Statuscode 404 zurückgegeben. Die entsprechende Detailfehlermeldung sieht so aus:

{
    "error": {
        "code": "406",
        "message": "Not all required values are available!"
    }
}

Nachfolgend finden Sie eine Tabelle mit allen bekannten Shiptrack.com-spezifischen Fehlercodes für diese Schnittstelle:

HTTP-Status	Description
401	Anmelde-Fehler
403	Lizenz zur Benutzung der Schnittstelle wurde nicht erworben.
404	Keine ETA-Berechnung für die übermittelten Werte gefunden.
406	Pflichtfelder fehlen.

Inhalt:

1 1 Allgemein
- 1.1 1.1 Einführung
- 1.2 1.3 Fehlerbehandlung
2 2 Anfragen
- 2.1 2.1 Aufbau der URL
- 2.2 2.2 Request body
- 2.3 2.3 Beispiele
  - 2.3.1 2.3.1 GET
  - 2.3.2 2.3.2 POST
3 3 Antwort
- 3.1 3.1 Mögliche quality types
4 4 Frachtführerkürzel

2 Anfragen

2.1 Aufbau der URL

Um eine voraussichtliche Lieferzeit anzufordern, muss die Endpunkt-URL die folgende Struktur haben:

https://service.shiptrack.com/clients/<Client-Id>/arrivaltimes

2.2 Request body

Feldname	Datentyp	Beschreibung	Pflichtfeld
CarrierName	String	Frachtführerkürzel	X
SenderZip	String	Postleitzahl des Absenders
SenderIsoA2	String	Zweistelliger Ländercode des Absenders (ISO 3166-1 Alpha 2)	X
RecipientZip	String	Postleitzahl des Empfängers
RecipientIsoA2	String	Ländercode des Empfängers (alphanumerisch), z. "DE" für Deutschland	X
ServiceType	String	Service code
QualityType	String	Genauigkeit der ETA-Berechnung	X
UseAdvancedSearch	String	Suche in allen Qualitätstypen

2.3 Beispiele

2.3.1 GET

<https://service.shiptrack.com/clients/<Client-Id>/arrivaltimes?CarrierName=CHP&SenderZip=8200&SenderIsoA2=CH&RecipientZip=9493&RecipientIsoA2=CH&UseAdvancedSearch=true>

2.3.2 POST

https://service.shiptrack.com/clients/<Client-Id>/arrivaltimes

{
  "CarrierName": "UPS",
  "SenderZip": "44565",
  "SenderIsoA2": "DE",
  "RecipientZip": "00049",
  "RecipientIsoA2": "IT",
  "ServiceType": null,
  "QualityType": "ZipToZip",
  "UseAdvancedSearch": "True"
}

3 Antwort

Wenn der Aufruf erfolgreich war, wird Folgendes zurückgegeben:

Feldname	Datentyp	Beschreibung
CarrierName	String	Frachtführerkürzel, mit dem die Retoure transportiert werden soll (siehe Punkt 4)
SenderZip	String	Postleitzahl des Absenders
SenderIsoA2	String	Zweistelliger Ländercode des Absenders (ISO 3166-1 Alpha 2)
RecipientZip	String	Postleitzahl des Empfängers
RecipientIsoA2	String	Ländercode des Empfängers (alphanumerisch), z. "DE" für Deutschland
ServiceType	String	Service code
QualityType	String	Genauigkeit der ETA-Berechnung
UseAdvancedSearch	String	Suche in allen Qualitätstypen
MedEtaInHours	String	Lieferzeit in Stunden (median)
MedEtaTime	String	Uhrzeit der voraussichtlichen Zustellung (median)

3.1 Mögliche quality types

Schlüssel	Beschreibung
ZipToZipWithService	Ergebnis mit CarrierName, SenderIsoA2, SenderZip, RecipientIsoA2, RecipientZip, ServiceType
ZipToZip	Ergebnis mit CarrierName, SenderIsoA2, SenderZip, RecipientIsoA2, RecipientZip
CountryToZip	Ergebnis mit CarrierName, SenderIsoA2, RecipientIsoA2, RecipientZip
ZipToCountry	Ergebnis mit CarrierName, SenderIsoA2, SenderZip, RecipientIsoA2
CountryToCountry	Ergebnis mit CarrierName, SenderIsoA2, RecipientIsoA2

{
    "@odata.context": "https://service.shiptrack.com/clients/00000000-0000-0000-0000-000000000000/$metadata#arrivaltimes/$entity",
    "Id": "ed0c88b5-8d5d-489c-b341-79eee0c388f1",
    "SenderZip": "44565",
    "SenderIsoA2": "DE",
    "RecipientZip": "00049",
    "RecipientIsoA2": "IT",
    "ServiceType": null,
    "CarrierName": "UPS",
    "QualityType": "ZipToZip",
    "ServiceType": null,
    "UseAdvancedSearch": True
    "MedEtaInHours": "55",
    "MedEtaTime": "09:42:00"
}

4 Frachtführerkürzel

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

Interfaces

REST API - Voraussichtliche Lieferzeiten