Order Details via Webhook

This Webhook is used to receive real-time updates of the Order Reallocation (Carrier Hopping) flow.

Overview

This webhook delivers real-time updates for order creation requests initiated via the api/v1/quickcom/reallocation endpoint. It enables clients to receive shipment creation status changes and carrier allocation/reallocation updates as the reallocation (carrier hopping) workflow progresses, without the need for polling.

Configuration

Reallocation (Carrier Hopping) updates are delivered to the same webhook endpoint configured for the Selected Status Webhook.

To enable this:

  • Configure the webhook URL and authentication credentials as described in the Selected Status Webhook setup.
  • No additional endpoint configuration is required specifically for reallocation events.

The webhook payload structure remains consistent with the Selected Status Webhook, with a few additional fields included to represent reallocation-specific details (such as reallocation status and carrier information).

Refer to the sample payloads below for a complete view of the reallocation-related fields.

Webhook Event Details

Notification Event IDNotification Event NameNotification Event DescriptionIs Terminal Event
115SHIPMENT_CREATION_SUCCESSFULReallocation completed successfully with a carrier allocated and shipment created. Shipment data is available. Final success state.Yes
116SHIPMENT_CREATION_FAILEDReallocation process timed out without any successful shipment manifestation, or the last manifestation attempt resulted in a non-success status. No shipment data available. Terminal failure state.Yes
117CARRIER_ALLOCATEDCarrier has been allocated and an active manifestation exists, waiting for rider to be allocated and/or order to be picked up within the reallocation time window. Shipment data is available. Reallocation is still in progress.No
118CARRIER_ALLOCATED_PROVISIONALLYCarrier allocated but not confirmed that a rider will be assigned and/or order will be picked up by the allocated carrier. This occurs when either reallocation timed out but last attempt succeeded, or manifestation was skipped due to cancellation errors from the carrier side. Shipment data available but enterprise should manage this now at their end. Terminal unconfirmed state.Yes
134REALLOCATION_ABORTEDThe reallocation flow has been aborted and terminated. The latest AWB cancellation was attempted as part of this termination; check the additional.awb_cancelled boolean flag to determine whether the cancellation succeeded or failed. This is a terminal state. (This event triggered in case the Cancellation API is called to terminate the ongoing Re-allocation flow)Yes
146REALLOCATION_PAUSEDSent when reallocation is paused because order creation is not responding, or a previous order is still being cancelled. The brand is informed that courier assignment is on hold. Reallocation can continue once order creation is working again. If the pause reaches 1 hour, reallocation is stopped.
(Note: No active AWB present in this state)
No
147REALLOCATION_UNEXPECTEDLY_ABORTEDSent when reallocation is stopped before a courier is confirmed. This happens when order creation fails and cannot be retried, or when reallocation has already been paused for 1 hour. No further courier attempts are made. (Note: No active AWB present in this state)Yes

Webhook Payload Fields

Field NameData TypeDescriptionValue Constraints
additional.notification_event_idintegerUnique identifier of the notification/webhook event. Refer to the notification event id to name mapping for more info.cannot be null
original_reference_numberstringUnique reference number of the order, as provided in the Reallocation API payload.cannot be null
timestampdatetimeUTC timestamp when the event was generated in the ClickPost system. Format: YYYY-MM-DD HH:MM:SScannot be null
additional.order_idstringSame Order ID as provided in the Reallocation API payload.cannot be null
waybillstringAWB/Waybill of the successfully created order. This AWB is automatically registered for tracking in the ClickPost system.can be null for SHIPMENT_CREATION_FAILED event
account_codestringCourier partner account name configured on the Clickpost dashboard.can be null for SHIPMENT_CREATION_FAILED event
cp_idintegerID of the courier partner. This can be found on the dashboard or you can refer it here.can be null for SHIPMENT_CREATION_FAILED event
additional.latest_status.reference_numberstringA new reference number generated from the original reference number by adding a sequential numeric prefix or suffix (e.g., “1-”, “2-”, “-1”, “-2”).can be null for SHIPMENT_CREATION_FAILED event
additional.shipping_labelstringURL to the generated shipping label of the order. If labels are not needed, this stays null.can be null for SHIPMENT_CREATION_FAILED event
additional.tracking_idbigint / longA special ID of the order/shipment used for tracking.can be null for SHIPMENT_CREATION_FAILED event
additional.security_keystringUUID security key of the order that needs to be stored at the enterprise's end.can be null for SHIPMENT_CREATION_FAILED event
additional.awb_cancelledbooleanIndicates whether the latest AWB (if present) was cancelled successfully after the reallocation flow was aborted.can be null for all events except REALLOCATION_ABORTED (with AWB)

Sample Webhook Payloads

{
    "notification_event": 115,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": 632,
    "account_code": "Blitz_HLD",
    "waybill": "BH1123456",
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 115,
        "order_id": "OID16238123",
        "shipping_label": "https://abc-shipping_label.clickpost.com/123",
        "tracking_id": 123456213,
        "security_key": "221000b9-e259-45fc-8adf-97507ddcea83",
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": "TEST_REF-1",
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": "Blitz_HLD",
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null,
        "awb_cancelled": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 116,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": null,
    "account_code": null,
    "waybill": null,
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 116,
        "order_id": "OID16238123",
        "shipping_label": null,
        "tracking_id": null,
        "security_key": null,
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": null,
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": null,
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null,
        "awb_cancelled": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 117,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": 632,
    "account_code": "Blitz_HLD",
    "waybill": "BH1123456",
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 117,
        "order_id": "OID16238123",
        "shipping_label": "https://abc-shipping_label.clickpost.com/123",
        "tracking_id": 123456213,
        "security_key": "221000b9-e259-45fc-8adf-97507ddcea83",
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": "3-TEST_REF",
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": "Blitz_HLD",
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null,
        "awb_cancelled": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 118,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": 632,
    "account_code": "Blitz_HLD",
    "waybill": "BH1123456",
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 118,
        "order_id": "OID16238123",
        "shipping_label": "https://abc-shipping_label.clickpost.com/123",
        "tracking_id": 123456213,
        "security_key": "221000b9-e259-45fc-8adf-97507ddcea83",
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": "TEST_REF-2",
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": "Blitz_HLD",
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null,
        "awb_cancelled": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 134,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": 632,
    "account_code": "Blitz_HLD",
    "waybill": "BH1123456",
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 134,
        "order_id": "OID16238123",
        "shipping_label": "https://abc-shipping_label.clickpost.com/123",
        "tracking_id": 123456213,
        "security_key": "221000b9-e259-45fc-8adf-97507ddcea83",
        "awb_cancelled": true,
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": "TEST_REF-2",
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": "Blitz_HLD",
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 134,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": null,
    "account_code": null,
    "waybill": null,
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 134,
        "order_id": "OID16238123",
        "shipping_label": null,
        "tracking_id": null,
        "security_key": null,
        "awb_cancelled": null,
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": null,
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": null,
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 146,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": null,
    "account_code": null,
    "waybill": null,
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 146,
        "order_id": "OID16238123",
        "shipping_label": null,
        "tracking_id": null,
        "security_key": null,
        "awb_cancelled": null,
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": null,
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": null,
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}
{
    "notification_event": 147,
    "timestamp": "2025-12-04T18:38:04Z",
    "cp_id": null,
    "account_code": null,
    "waybill": null,
    "original_reference_number": "TEST_REF",
    "additional": {
        "notification_event_id": 147,
        "order_id": "OID16238123",
        "shipping_label": null,
        "tracking_id": null,
        "security_key": null,
        "awb_cancelled": null,
        "latest_status": {
            "status": null,
            "clickpost_status_description": null,
            "clickpost_status_bucket": null,
            "reference_number": null,
            "clickpost_status_bucket_description": null,
            "remark": null,
            "timestamp": null,
            "location": null,
            "clickpost_city": null,
            "clickpost_status_code": null,
            "latitude": null,
            "longitude": null
        },
        "courier_partner_edd": null,
        "is_rvp": null,
        "ndr_status_code": null,
        "ndr_status_description": null,
        "forward_awb": null,
        "self_shipped": null,
        "forward_reference_number": null,
        "item_info": [],
        "account_code": null,
        "npr_status_code": null,
        "npr_status_description": null,
        "name": null,
        "order_value": null,
        "email": null,
        "phone": null
    },
    "remark": null,
    "clickpost_status_description": null,
    "status": null,
    "clickpost_status_bucket": null,
    "clickpost_status_bucket_description": null,
    "channel_name": null,
    "location": null,
    "clickpost_city": null,
    "clickpost_status_code": null,
    "rto_awb": null,
    "latitude": null,
    "longitude": null
}

Did this page help you?