Übermittelte Daten

Es besteht die Möglichkeit immer wenn sich der Status einer Sendung beim Versanddienstleister ändert einen HTTP POST Request auf eine konfigurierte URL auszulösen.

📘
Retry-Verhalten & Signatur-Prüfung
Dieser WebHook folgt dem allgemeinen Aufbau (inkl. security-Objekt zur HMAC-SHA256-Signaturprüfung) und Retry-Verhalten (bis zu 5 weitere Versuche über 10 Min. bis 4 Std.), die auf der übergeordneten Seite WebHooks beschrieben sind.

Übermittelte Daten

{
  "data": {
    "carrier": "DHL",
    "carrierTrackingLink": "https://www.examle.com",
    "trackingCode": "00434598745697543541",
    "orderNumber": "ORDER12345",
    "customerNumber": "CUS12345",
    "shippedOn": 1587638764,
    "deliveredOn": 1587638904,
    "shipmentType": "shipment",
    "shipmentState": "delivered",
    "shop": {
      "token": "PQT",
      "name": "PAQATO Shop"
    },
    "events": [
      {
        "id": "1cbe7458-28d7-410b-9be3-0b72f9564056",
        "eventId": 5,
        "timestamp": 1587638764,
        "shortDescription": "Im Zustellfahrzeug",
        "longDescription": "Die Sendung wurde in das Zustellfahrzeug geladen",
        "city": "Musterstadt",
        "country": "DE",
        "notification": {
          "id": 35,
          "name": "Im Zustellfahrzeug"
        },
        "estimatedDelivery": {
          "from": 1587638804,
          "to": 1587639004
        }
      },
      {
        "id": "89a01fb1-6b8f-5006-aade-841a0b395e01",
        "eventId": 12,
        "timestamp": 1587638804,
        "shortDescription": "In Filiale abgegeben",
        "longDescription": "Die Sendung wurde in der Filiale ...",
        "city": "Musterstadt",
        "country": "DE",
        "notification": {
          "id": 41,
          "name": "Zugestellt an Empfänger"
        },
        "location": {
          "name": "Musterfiliale",
          "street": "Musterstraße 1a",
          "postalCode": "12345",
          "city": "Musterstadt",
          "country": "DE",
          "openingHours": {
            "1": [
              {
                "open": "08:00",
                "close": "20:00"
              }
            ],
            "2": [
              {
                "open": "08:00",
                "close": "20:00"
              }
            ]
          }
        }
      }
    ]
  }
}

🚧
Sendungsverfolgungsnummern
Bei den meisten Paketdienstleistern / Speditionen sind die Sendungsverfolgungsnummern aus einem zugewiesenen Nummernkreis und wiederholen sich nach einem unbestimmten Zeitraum. Daher sollte die Sendungsverfolgungsnummer ausschließlich mit einem weiteren Wert zusammen zur Identifikation einer Sendung verwendet werden.

Attribut	Typ	Beschreibung
`carrier`	`string`	Name des Paketdienstleisters / der Spedition
`carrierTrackingCode`	`string`	Tracking Link des Carriers
`trackingCode`	`string`	Sendungsverfolgungsnummer
`orderNumber`	`string`	Bestell-/Auftragsnummer
`customerNumber`	`string`	Kundennummer
`shippedOn`	`int`	Die Sekunden seit dem 01.01.1970 (UTC) - An PAQATO übergebener Versandzeitpunkt
`deliveredOn`	`int`	(Optional) Die Sekunden seit dem 01.01.1970 (UTC) - Der Zeitpunkt der Zustellung laut Paketdienstleister / Spedition
`shipmentType`	`string`	Art der Sendung (shipment = Normale Sendung, reshipment = Rücksendung, return = Retoure)
`shipmentState`	`string`	Stand der Zustellung (undelivered, delivered)
`events`	`array`	Die Historie der Sendung

shop

Das shop Objekt gibt zurück in welchem der bei PAQATO hinterlegten Shops die Sendung gespeichert ist:

{
  "token": "PQT",
  "name": "PAQATO Shop"
}

Attribut	Typ	Beschreibung
`token`	`string`	Das Token des Shops bei PAQATO.
`name`	`string`	Der Name des Shops bei PAQATO.

event

Jedes event-Objekt spiegelt ein Ereignis auf dem Versandweg wider:

{
  "id": "89a01fb1-6b8f-5006-aade-841a0b395e01",
  "eventId": 1,
  "timestamp": 1587638804,
  "shortDescription": "In Filiale abgegeben",
  "longDescription": "Die Sendung wurde in der Filiale ...",
  "systemLocation": "Paketshop / Postfiliale",
  "systemState": "bereit zur Abholung durch den Empfänger",
  "systemEvent": "Zusatzinfo",
  "city": "Musterstadt",
  "country": "DE",
  "notification": {},
  "location": {},
  "estimatedDelivery": {}
}

Attribut	Typ	Beschreibung
`id`	`string`	Eindeutige UUID Version 5.
`eventId`	`int`	Interner Typ des Events (siehe Liste aller Ereignisse (Events) )
`timestamp`	`int`	Die Sekunden seit dem 01.01.1970 (UTC)
`shortDescription`	`string`	Kurzbeschreibung des Ereignisses
`longDescription`	`string`	Ausführliche Beschreibung des Ereignisses
`systemLocation`	`string`	Standort wie in der WebApp
`systemState`	`string`	Status wie in der WebApp
`systemEvent`	`string`	Vermerk wie in der WebApp
`city`	`string`	Name der Stadt in der das Event ausgelöst wurde (sofern vom Paketdienstleister zur Verfügung gestellt. Sonst leerer String.)
`country`	`string`	Land in dem das Event ausgelöst wurde (sofern vom Paketdienstleister zur Verfügung gestellt. Sonst leerer String.)
`notification`	`object`	(Optional) Hinweis welche Benachrichtigungen zu diesem Ereignis versandt wird
`location`	`object`	(Optional) Informationen zum Standort der Sendung
`estimatedDelivery`	`object`	(Optional) Voraussichtliches Lieferdatum der Sendung

notification

Das optionale notification-Objekt ist ein Hinweis darauf, welche Benachrichtigung von PAQATO verschickt wird:

{
  "notification": {
    "id": 1,
    "name": "Im Zustellfahrzeug"
  }
}

Attribut	Typ	Beschreibung
`id`	`int`	Interne ID der Notification (siehe Liste aller Benachrichtigungen (Notifications))
`name`	`string`	Lesbarer Name der Notification

location

Das optionale location-Objekt enthält Informationen zum Ablageort einer Sendung:

{
  "location": {
    "name": "Musterfiliale",
    "street": "Musterstraße 1a",
    "postalCode": "12345",
    "city": "Musterstadt",
    "country": "DE",
    "openingHours": {}
  }
}

Attribut	Type	Beschriebung
`name`	`string`	Optionaler Name des Orts
`street`	`string`	Strasse inklusive Hausnummer
`postalCode`	`string`	Postleitzahl
`city`	`string`	Stadt
`country`	`string`	Land (ISO 3166 ALPHA-2)
`openingHours`	`object`	(Optional) Öffnungszeiten des Sendungsstandorts

openingHours

Das optionale openingHours-Objekt enthält die Öffnungszeiten des Ablageorts einer Sendung. Für jeden Wochentag können ein oder mehrere Objekte mit den Öffnungszeiten hinterlegt sein.

{
  "openingHours": {
    "1": [
      {
        "open": "08:00",
        "close": "20:00"
      }
    ],
    "2": [
      {
        "open": "08:00",
        "close": "20:00"
      }
    ]
  }
}

Attribut	Typ	Beschreibung
`1-7`	`array`	Wochentag (1 = Montag, 7 = Sonntag)

estimatedDelivery

Das optionale estimatedDelivery-Objekt enthält Informationen über den Zeitraum der voraussichtlichen Zustellung. Sind fromund to identisch gilt der gesamte Tag als Zeitraum, da ausschließlich ein Datum bekannt ist und keine Uhrzeiten übermittelt wurden.

{
  "estimatedDelivery": {
    "from": 1587638804,
    "to": 1587639004
  }
}

Attribut	Typ	Beschreibung
`from`	`int`	Die Sekunden seit dem 01.01.1970 (UTC) - Startzeitpunkt des Zeitraums der voraussichtlichen Zustellung
`to`	`int`	Die Sekunden seit dem 01.01.1970 (UTC) - Endzeitpunkt des Zeitraums der voraussichtlichen Zustellung

Retry-Verhalten & Signatur-Prüfung