Rider Status Change Webhook

This article helps you understand the webhook information for Rider Status Update event

Written By Ops UrbanPiper (Collaborator)

Updated at August 10th, 2021

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

  1. How does the Rider Status Update works?
    - From the time the order is placed and it is delivered to the end customer, whereabouts information of the delivery rider is being captured from the aggregator and send it to the POS system.

  2. What is the type of HTTP request?
    - POST

  3. What is "store.ref_id" in the request payload?
    - It's the POS store id.

  4. From which all aggregators Rider details information is expected?
    - Zomato and Swiggy

  5. Is it mandatory to capture the data?
    - Yes, for the smooth end-to-end integration it is mandatory.

  6. Does the Rider Status information will be available for all the orders of Zomato and Swiggy?
    - Yes, for all partner delivery orders. By any chance, if the aggregators are not sending any rider status then it won't be possible to relay the information to POS partners.

  7. What is the OTP to be shared with Rider?
    - The last 4 digits of the customer's phone number in the order relay payload. This OTP is only for Zomato orders.

  8. Is it required to maintain all the status under "status_updates" array?
    - Need not to be but it will be helpful if POS partners store the logs of status updates that can show it on the POS screen.

  9. What all parameters are mainly important to show on the POS applications?
    • "delivery_info.delivery_person_details.name"
    • "delivery_info.delivery_person_details.phone"
    • "delivery_info.current_state.

  10. Will this webhook be triggered when the "delivery_type": "self" in Order Relay payload?
    - No.

  11. Where is the aggregator order_id?
    - "additional_info.external_channel.order_id".

  12. How the workflow of "bag_return_otp" works for Zomato?
    - To enable this workflow, the merchant has to get the flag enabled at the Zomato backend. Zomato generates OTP for a merchant that has to be shared with the delivery rider when the rider returns the bag to the merchant after the delivery of an order.

Was this article helpful?