Developers
API referenceBusiness sign in

Schema

WebhookShipmentEvent

Body for shipment.*, payment.*, refund.processed and locker.overage_due. No names, phones, addresses, codes or proof.

Fields

WebhookShipmentEvent fields
FieldTypeDescription
idRequiredstring (uuid)Stable event ID; deduplicate on it.
typeRequiredWebhookEventName
created_atRequiredstring (date-time)
dataRequiredobject
shipmentRequiredWebhookShipment
pickupOptionalobjectOnly on shipment.pickup_expiring.
expires_atRequiredstring (date-time)
location_typeRequiredenumOne of POINT, LOCKER
promiseOptionalWebhookPromiseOnly on shipment.promise_revised and shipment.promise_missed.
home_deliveryOptionalobjectOnly on shipment.home_attempt_failed and shipment.redirected_to_point (Relay Home).
attempt_reasonOptionalstringWhy the one home attempt failed.
fallback_point_codeOptionalstringThe fallback Qoene Point chosen at booking.
fallback_point_nameOptionalstring
routeOptionalenumHow 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_changeOptionalobjectOnly on shipment.receiver_changed.
idRequiredstring
kindRequiredenumOne of DESTINATION_POINT, FALLBACK_POINT, HOLD_EXTENSION
reasonOptionalstring
from_point_codeOptionalstring
to_point_codeOptionalstring
to_point_nameOptionalstring
extension_hoursOptionalinteger
hold_ends_atOptionalstring (date-time)
amount_minorOptionalinteger
overstayOptionalobjectOnly on shipment.overstay_started and shipment.overstay_paid.
hold_ended_atOptionalstring (date-time)
location_typeOptionalenumOne of POINT, LOCKER
rate_per_day_minorOptionalinteger
cap_minorOptionalinteger or null
return_afterOptionalstring (date-time)
amount_minorOptionalinteger
paid_byOptionalenumOne of RECEIVER, BUSINESS, SPLIT
business_covered_minorOptionalinteger
receiver_paid_minorOptionalinteger

Used by