Schema
WebhookShipmentEvent
Body for shipment.*, payment.*, refund.processed and locker.overage_due. No names, phones, addresses, codes or proof.
Fields
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | Stable event ID; deduplicate on it. |
typeRequired | WebhookEventName | |
created_atRequired | string (date-time) | |
dataRequired | object | |
shipmentRequired | WebhookShipment | |
pickupOptional | object | Only on shipment.pickup_expiring. |
expires_atRequired | string (date-time) | |
location_typeRequired | enum | One of POINT, LOCKER |
promiseOptional | WebhookPromise | Only on shipment.promise_revised and shipment.promise_missed. |
home_deliveryOptional | object | Only on shipment.home_attempt_failed and shipment.redirected_to_point (Relay Home). |
attempt_reasonOptional | string | Why the one home attempt failed. |
fallback_point_codeOptional | string | The fallback Qoene Point chosen at booking. |
fallback_point_nameOptional | string | |
routeOptional | enum | How the parcel reaches the point: carried there by the rider the same day, or back through the hub.One of CARRY_TO_POINT, RETURN_TO_HUB |
receiver_changeOptional | object | Only on shipment.receiver_changed. |
idRequired | string | |
kindRequired | enum | One of DESTINATION_POINT, FALLBACK_POINT, HOLD_EXTENSION |
reasonOptional | string | |
from_point_codeOptional | string | |
to_point_codeOptional | string | |
to_point_nameOptional | string | |
extension_hoursOptional | integer | |
hold_ends_atOptional | string (date-time) | |
amount_minorOptional | integer | |
overstayOptional | object | Only on shipment.overstay_started and shipment.overstay_paid. |
hold_ended_atOptional | string (date-time) | |
location_typeOptional | enum | One of POINT, LOCKER |
rate_per_day_minorOptional | integer | |
cap_minorOptional | integer or null | |
return_afterOptional | string (date-time) | |
amount_minorOptional | integer | |
paid_byOptional | enum | One of RECEIVER, BUSINESS, SPLIT |
business_covered_minorOptional | integer | |
receiver_paid_minorOptional | integer |
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