This webhook endpoint facilitates real-time order updates and supports critical workflows, including:

Order Creation: Ensures synchronization by sending real-time status updates for successful or failed operations.
Fire Order Creation: Keeps integration partners updated on order status in real time.
Order Cancellation by Integration Partner: Notifies whether the POS system has accepted or rejected the cancellation request.
Order Cancellation by POS System: Sends cancellation notifications initiated by the POS system to the integration partner.

Integration Partner Webhook Requirements

Integration partners are encouraged to implement this webhook to enable real-time order status update.

1. Webhook Specification

Endpoint: HTTPs
RequestType: POST
RequestBody: Please see below sample request body

2. Webhook Request

Khumbu will send following request object to Order Status webhook endpoint. Error object will be populated in case of errors only.

Please refer to the Order Status Webhook Payload guide for a detailed explanation of each parameter and its required format.

Request Body


{
    "providerOrderId": "87b0599o-4906-4Y24-n0Nc-08MkP1897ad4",
    "providerOrderNumber": "48d2abe0-981d-4ddc-8d4f-fd12e0f67d66",
    "providerName": "standardprovider",
    "partnerName": "simphony",
    "marketName": "plkpl",
    "storeInformation": {
        "providerStoreId": "99999",
        "partnerStoreId": "12345"
    },
    "orderStatus":"SUCCESS",
    "error": {
      "reason":"reason for failure",
      "code":"KS-1001"
    }
}

3. Webhook Response

Response Body

HTTP code :

Success (HTTP code - 200)
Failure ( any other HTTP code, along with error message)