Webhook Shipping Integration Order Exception

Sent when a mirrored TMS integration order enters an exception state.

postWebhookshipping_integration.order.exception

Payload

event_type'shipping_integration.order.staged' | 'shipping_integration.order.in_progress' | 'shipping_integration.order.completed' | 'shipping_integration.order.exception' | 'shipping_integration.order.cancelled' required

The order status event that occurred

event_timestampstring date-time required

UTC timestamp when the event occurred

shipping_integration_order_idstring required

The unified shipping integration order ID

provider_org_idstring required

The courier provider organization ID

integration_order_idstring required

The provider's order ID in their TMS

previous_status'staged' | 'in_progress' | 'completed' | 'cancelled' | 'exception'

new_status'staged' | 'in_progress' | 'completed' | 'cancelled' | 'exception' required

reference_numbersstring[]

Associated reference numbers on the order

Response

Successful Response

{"stackTrail":"webhooks:shipping_integration.order.exception:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.