Order Status Change Webhook

This webhook will send the order status from aggregators to POS via UP system.

Written By Ops UrbanPiper (Collaborator)

Updated at August 10th, 2021

API Document Reference - https://api-ordering-docs.urbanpiper.com/#order-status-change

  1. What is the purpose of this API?
    - When an order state transition happens from its previous state in the UrbanPiper system through the aggregators/POS system/satellite application, a webhook will be triggered to the configured endpoint(POS system endpoint) in the Quint dashboard. Thus, the POS system gets updated by the change in order state through this webhook.

  2. What is "store_id" in the payload?
    - It is the POS store id.

  3. What is the difference between "additional_info.external_channel.order_id" and "order_id"?
    • "additional_info.external_channel.order_id" — the aggregator order id.
    • "order_id" — the Urbanpiper order id.

  4. Under what all current order states can order get cancelled?
    - No matter the order is Acknowledged, Food Ready, Dispatched, etc aggregators have all the rights to cancel the order irrespective of the previous order status is.

  5. Is it possible to know the share of the merchant when the order is cancelled by the aggregator or merchant?
    - No. Aggregators don't share that information with us. Based on at what stage the order got cancelled, the aggregator and merchant will have a mutual understanding of it.

  6. What is "updater" in the webhook payload?
    - This will give you the information on who has done the order status update for a given order. This "updater" array comprises "name" and "username".
    • "name" - the identifier name given while creating the credentials.
    • "username" - the login username of quint/API username(key).

  7. How to take care of the scenario when the order is marked Food Ready and the rider hasn't reached the outlet?
    - Given the scenario, at the end of the day, keep a comment against the bill which is later used during the reconciliation when checking with the aggregator's data.

  8. What is the new state "customer_cancelled"?
    - This is a new state you can expect in the order status update webhook callback when the order cancellation request is raised by the end customer.

  9. What is the significance of "timeout_secs"?
    - This indicates the customer has to accept/reject the customer requested order cancellation within the time specified inside the attribute.

Was this article helpful?