Sign in
Events/Logistics
shipment.cancelled

Shipment cancelled

A shipment was cancelled before pickup — by merchant action or via the cancel API.

When this fires

Fires whenever the underlying state change happens on the platform.

Sample payload

This is the exact envelope shape we POST to your endpoint — outer wrapper plus the per-event data payload. Field values are randomised on each render so you see the general shape, not a fixed example.

json
{
  "id": "b8563c10-5435-411c-bc58-e15b54931229",
  "event": "shipment.cancelled",
  "created": "2026-06-12T02:18:48.035Z",
  "data": {
    "shipmentId": "cmc603l9wr890000000000000",
    "merchantReference": "PHR-7136",
    "reason": "Duplicate order",
    "carrier": "fez",
    "providerShipmentId": "SHP-KE3K5QW",
    "cancelledAt": "2026-06-12T02:18:48.035Z"
  }
}

Use cases

  • Trigger any downstream automation that cares about this state change.
  • Mirror the event into your data warehouse for analytics.
  • Notify a human channel for high-signal events.

Subscribe in the dashboard

To start receiving this event, add it to a webhook's subscription list in Developers → Webhooks. Wildcard subscriptions ( shipment.*) work too — see the webhooks guide for the matching rules.