Triggered when a shipment status changes
Security
BearerAuth
The type of webhook event
Enum:"shipment.status_updated""shipment.delivery_status_updated"
Base Shipment schema used by webhook payloads. Read responses use Shipment, which extends this schema with the proof-of-delivery fields.
Example:
{ "id": 789012, "order_id": 123456, "sales_channel_id": 10, "merchant_order_id": "ORD-1001", "status": "shipped", "delivery_status": "in_transit", "shipment_provider": "DHL", "shipping_method": "Standard", "tracking_number": "1234567890123456", "tracking_url": "https://dhl.com/track/1234567890123456", "created_at": "2023-10-01T12:00:00Z", "shipped_at": "2023-10-02T08:00:00Z", "delivered_at": "2023-10-03T14:30:00Z", "updated_at": "2023-10-02T08:00:00Z", "warehouse_id": 42, "items": [ { … } ] }
POST
{ "event_type": "shipment.status_updated", "event_id": "123e4567-e89b-12d3-a456-426614174001", "timestamp": "2023-10-01T15:00:00Z", "data": { "id": 789012, "order_id": 123456, "sales_channel_id": 10, "status": "shipped", "items": [ … ] } }