REST API - Sendungen und Statusdaten

1   Allgemein

1.1   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.2   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ück geliefert, 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:

1 2 3 4 { "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

Die Endpunkt-URL der Sammelabfrage hat folgende Struktur:

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 aufgerufen. Das Ergebnis wird als JSON-String zurück geliefert 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ück geliefert, 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ück geliefert, 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

Um die Einzelabfrage zu nutzen, muss die URL folgende Struktur besitzen:

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ück geliefert 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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "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 ecovium), 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ück geliefert 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:

1 2 3 4 { "shipment": [], "shipment_count": "0" }

 

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 { "shipment": [{ "frachtfuehrer": "UPS", "abs_adr_01": "ECOVIUM 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": "LANGENHAGEN", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "23:18:00", "date": "10/08/2015" }, "status_details": "Departure Scan", "collection_index": "4" }, { "status_country": "DE", "status_city": "FRANKFURT", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "04:08:00", "date": "10/09/2015" }, "status_details": "Arrival Scan", "collection_index": "5" }, { "status_country": "DE", "status_city": "FRANKFURT", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "06:26:00", "date": "10/09/2015" }, "status_details": "Out For Delivery", "collection_index": "6" }, { "status_country": "DE", "status_city": "OFFENBACH", "status_zip": "63073", "status_Consignee": "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", "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": "LANGENHAGEN", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "23:18:00", "date": "10/08/2015" }, "status_details": "Departure Scan", "collection_index": "4" }, { "status_country": "DE", "status_city": "FRANKFURT", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "04:08:00", "date": "10/09/2015" }, "status_details": "Arrival Scan", "collection_index": "5" }, { "status_country": "DE", "status_city": "FRANKFURT", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "05:56:00", "date": "10/09/2015" }, "status_details": "Out For Delivery", "collection_index": "6" }, { "status_country": "DE", "status_city": "FRANKFURT", "status_code": "In transit", "status_path": [{ "collection_index": "1", "status_code": "transit" }], "status_path_count": "1", "status_date": { "time": "06:26:00", "date": "10/09/2015" }, "status_details": "Out For Delivery", "collection_index": "7" }, { "status_country": "DE", "status_city": "OFFENBACH", "status_zip": "63073", "status_Consignee": "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", "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", "status_tags": [{ "status_code": "delivered", "collection_index": "1" }], "status_tags_count": "1" }], "shipment_count": "1" }

 

2.4.1    Format der Shipment tags

1 2 3 4 5 6 7 8 9 "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ück gelieferten 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 Shiptrack 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 mit gesendet werden. Alle Felder befinden sich mindestens auf der Shipment-Ebene, weswegen diese nicht explizit angegeben wird.

Feld

Beschreibung

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:

1 2 3 4 5 6 7 8 {    "timezone": {       "name": "UTC",       "offset": "+0000"    },    "time": "08:49:08",    "date": "07/03/2013" }

Feld

Beschreibung

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   Shipment-ebene

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

Feld

Beschreibung

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_locale

Sprache 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   Shipmentstatus-ebene

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

Feld

Beschreibung

Feld

Beschreibung

status_date

Statusdatum

status_code

Shiptrack-Statuscode

 

2.4.5.3   Package-ebene

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

Feld

Beschreibung

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   Packagestatus-ebene

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

Feld

Beschreibung

Feld

Beschreibung

status_date

Statusdatum

status_details

Statusdetails

status_code

Statuscode

status_path.status_code

Shiptrack-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   Dokument-ebene

Diese Ebene befindet sich innerhalb der Shipment-Ebene. Dieses enthält Dokumente wie Label oder Abliefernachweise (PODs).

Feld

Beschreibung

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", "Return"

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   Incident-ebene

Diese Ebene befindet sich innerhalb der Shipment-Ebene.

Feld

Beschreibung

Feld

Beschreibung

name

Name der Definition, die gegriffen hat

definition

Guid zur Definition, die gegriffen hat

created

Erstellungsdatum des Incidents

 

2.4.5.7   Timing-ebene

Diese Ebene befindet sich innerhalb der Shipment-Ebene und enthält GTA, ETA oder FIX timings.

Feld

Beschreibung

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_guid

Eindeutige Id der zugrundeliegenden Versandart

source.transit_times_guid

Eindeutige Id der zugrundeliegenden

Versandzeit in der

 Versandart

source.hours_added.hours_total

Summe der Tage aus hours_saturday, hours_sunday & hours_holiday

source.hours_added.hours_saturday

Anzahl der Samstage, die auf die Laufzeit drauf gerechnet wurden

source.hours_added.hours_sunday

Anzahl der Sonntage, die auf die Laufzeit drauf gerechnet wurden

source.hours_added.hours_holiday

Anzahl der Feiertage, die auf die Laufzeit drauf gerechnet wurden

creation_date

Erstellungszeitpunkt der Berechnung

range.from_date

Errechneter Lieferzeitpunkt von (Datum + Uhrzeit)

range.to_date

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

 

3.2   Frachtführerkürzel

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