shipment.itinerary.updated

Overview

Fired when the itinerary of a shipment (master bill of lading) changes. This event operates at the shipment level and includes data about all containers associated with the master bill, providing a consolidated view of the shipment's routing and schedule changes.

When This Event Fires

The system detects itinerary-level changes on a master bill of lading during report processing. This includes changes to:

• ETA, ETD, or other schedule dates at the shipment level
• Vessel or voyage information
• Port assignments
• Terminal assignments

📘

This event complements container.itinerary.updated by providing a shipment-level view. If you track individual containers, use container.itinerary.updated. If you track by master bill and want to see all containers in one payload, use this event.

Payload Structure

{
  "event": "shipment.itinerary.updated",
  "data": {
    "number": "MEDU1234567",
    "scacCode": "MSCU",
    "referenceNumbers": ["PO-12345"],
    "containers": [
      { /* IContainerVoyageResponse for container 1 */ },
      { /* IContainerVoyageResponse for container 2 */ }
    ],
    "account": {
      "region": "US",
      "domain": "example.com"
    }
  },
  "deliveryAttempt": 1,
  "pendingRetries": 4,
  "sentAt": "2025-07-19T17:00:00.654Z"
}

data object fields

Each entry in containers is the full container response — the same format as returned by GET /v1/container/:containerId.

Common Use Cases