Schema
WebhookShipment
An object of the Qoene Delivery API.
Fields
| Field | Type | Description |
|---|---|---|
idRequired | string | LIVE shipments use QDSHP or QD-SHP-. TEST shipments use QDTST or QD-TST-.Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$ |
tracking_numberRequired | string | |
serviceRequired | enum | One of EXPRESS, RELAY |
statusRequired | string | |
milestoneOptional | string | Present on events queued from NB07 onward. |
view_modeOptional | string |
Used by
- Webhook
shipment.created - Webhook
shipment.status_changed - Webhook
shipment.driver_assigned - Webhook
shipment.driver_arriving - Webhook
shipment.dropoff_accepted - Webhook
shipment.picked_up - Webhook
shipment.in_transit - Webhook
shipment.received_at_hub - Webhook
shipment.arrived_at_pickup - Webhook
shipment.ready_for_pickup - Webhook
shipment.ready_in_locker - Webhook
shipment.delivered - Webhook
shipment.collected - Webhook
shipment.pickup_failed - Webhook
shipment.delivery_attempt_failed - Webhook
shipment.exception - Webhook
shipment.return_requested - Webhook
shipment.return_started - Webhook
shipment.return_at_origin - Webhook
shipment.returned - Webhook
shipment.cancelled - Webhook
payment.confirmed - Webhook
payment.failed - Webhook
refund.processed - Webhook
locker.overage_due - Webhook
shipment.out_for_delivery - Webhook
shipment.pickup_expiring - Webhook
shipment.promise_revised - Webhook
shipment.promise_missed - Webhook
shipment.home_attempt_failed - Webhook
shipment.redirected_to_point - Webhook
shipment.receiver_changed - Webhook
shipment.overstay_started - Webhook
shipment.overstay_paid