1 General

1.1 Introduction

Below is a description of the interface that the Shiptrack.com service offers. All queries are made via HTTPS. The HTTP headers listed in the table below must be set with the values listed. The caller is authenticated at the interface using a previously defined username and password using the HTTP Basic Authentication Method (refer to RFC2617).

HTTP-Header	Value
Content-Type	application/json

1.3 Error handling

To ensure that the caller receives a meaningful error message when an error occurs in the interface, the interface sends a response with an HTTP status code that represents the error. In addition, a message is returned that contains detailed information about the error. For example, for the error that a customer is specified as parameter that does not exist, the HTTP status code 404 is returned. The corresponding detail error message looks like this:

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

Below is a table with all known Shiptrack.com specific error codes for this interface:

HTTP-Status	Description
401	Authentication error.
403	Interface usage was not purchased.
404	No eta found for provided information.
406	Mandatory values missing.

Inhalt:

2 Request via POST

2.1 Endpoint path structure

To request an arrival time, the endpoint URL must have the following structure:

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

2.2 Request body

Field name	Data type	Description	Required
CarrierName	String	Carrier abbreviation	X
SenderZip	String	Sender postal code
SenderIsoA2	String	Two-digit sender country code (ISO3166)	X
RecipientZip	String	Recipient postal code
RecipientIsoA2	String	Two-digit recipient country code (ISO3166)	X
ServiceType	String	Service type of the carrier
QualityType	String	Accuracy specification	X
UseAdvancedSearch	String	Search in all quality types

2.3 Examples

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 Response

If the call was successful, the following will be returned:

Field name	Data type	Description
CarrierName	String	Carrier short name (see 4 Carrier Abbreviation)
SenderZip	String	Sender postal code
SenderIsoA2	String	Two-digit sender country code (ISO3166)
RecipientZip	String	Recipient postal code
RecipientIsoA2	String	Two-digit recipient country code (ISO3166)
ServiceType	String	Service type of the carrier
QualityType	String	Accuracy specification
UseAdvancedSearch	String	Search in all quality types
MedEtaInHours	String	Running time in hours (median)
MedEtaTime	String	Delivery time (median)

3.1 Possible quality types

Key	Description
ZipToZipWithService	Search by CarrierName, SenderIsoA2, SenderZip, RecipientIsoA2, RecipientZip, ServiceType
ZipToZip	Search by CarrierName, SenderIsoA2, SenderZip, RecipientIsoA2, RecipientZip
CountryToZip	Search by CarrierName, SenderIsoA2, RecipientIsoA2, RecipientZip
ZipToCountry	Search by CarrierName, SenderIsoA2, SenderZip, RecipientIsoA2
CountryToCountry	Search by 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 Carrier abbreviation

All currently known carrier abbreviations are listed below.

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
CEV	CEVA Logistics
CHC	Swiss Post Cargo
CHE	Schweizer Post Express
CHP	Schweizer Post (CH)
CHPFREIGHT	Schweizer Post Fracht (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
ECB	Camel24
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
GLSCRO	General Logistic Systems Croatia
GON	General Overnight (GO!) Express & Logistics
GPC	Geis Parcel Slovakia CZ
GRM	Royal Mail
GSM	The Delivery Group (Secured Mail)
GWW	Gebrüder Weiss Gesellschaft m.b.H.
HEPPNER	Spedition Heppner
HES	Hermes 2 Man Handling
HHUBER	Heinz Huber Internationale Spedition
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 (by ecovium)
NELLENQUACK	Nellen & Quack Spedition und Logistik
NGL	GLS Netherlands
NOERPEL	Spedition Noerpel
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
PIT	Poste Italiane
PKT	Packeta
PLP	Poczta Polska
PPL	Professional Parcel Logistic
RABEN	Raben Group
RHE	Rhenus Logistics
RKL	Rieck Logistik-Gruppe
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)
TPO	Česká pošta
TRANSLAND	Transland Spedition GmbH
UFP	FOXPOST
UKM	DHL Parcel UK Mail
UPS	United Parcel Service
WLS	WLS Spedition GmbH
YDL	Yodel Delivery Network Limited
ZOBEL	Gebr. Zobel & Co. Speditions GmbH

REST API - Arrival Times