Shipment updated and tracking webhook event

{
  "version": "1.0",
  "eventType": "logistics.shipment.updated",
  "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "shipmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state": "AWAITING_BOOKING",
    "events": [
      {
        "eventId": "<string>",
        "type": "BOOKED",
        "eventDate": "2023-11-07T05:31:56Z",
        "description": "<string>"
      }
    ],
    "reference": "<string>",
    "reference2": "<string>",
    "trackingNumber": "<string>",
    "trackingUrl": "<string>"
  }
}

These events are fired when a shipment changes. These changes can happen due to a tracking event. Or a collection/delivery being booked with the carrier.

Event Payload

Webhook data for a shipment updates. Tracking events, delivery and collection updates all contribute to the creation of this event

version

enum<string>

required

Webhook event version

Available options:

1.0

eventType

enum<string>

required

Available options:

logistics.shipment.updated

eventId

string<uuid>

required

Webhook event Id

data

object

required

Show child attributes

Return Created

API Documentation

Endpoints

Webhooks

Shipment updated and tracking webhook event

Event Payload

API Documentation

Endpoints

Webhooks

Documentation Index

​Event Payload

Event Payload