Hyperlocal
Sandbox Testing
These APIs are available only in the staging environment. Use them to simulate order flow and test your callback handler.
Trigger them from the Callback Sandbox Postman Collection or via curl.
Status Update Flow
| Step | Status | Endpoint |
|---|---|---|
| 1 | ALLOTTED | PUT /app/v3/sandbox/clusters/orders/{sfx_order_id}/allot/ |
| 2 | ARRIVED | POST /app/v3/sandbox/order/{sfx_order_id}/update-rider-arrival/ |
| 3 | DISPATCHED | PUT /app/v3/sandbox/order/{sfx_order_id}/collect/ |
| 4 | ARRIVED_CUSTOMER_DOORSTEP | PUT /app/v3/sandbox/order/{sfx_order_id}/customer-doorstep-arrival/ |
| 5 | DELIVERED | PUT /app/v3/sandbox/order/{sfx_order_id}/deliver/ |
Alternative flows:
| Status | Endpoint |
|---|---|
CANCELLED_BY_CUSTOMER | PUT /app/v3/sandbox/order/{sfx_order_id}/customer-return/ |
RETURNED_TO_SELLER | PUT /app/v3/sandbox/order/{sfx_order_id}/seller-return/ |
Allot Rider
Code
Pass "only_allot": 1 to trigger the acceptance callback.
Note: You may receive either ALLOTTED or ACCEPTED callback. If the order is already allotted and this API is called with only_allot: 1 to receive the ACCEPTED callback, the ACCEPTED callback will not be sent.
Update Rider Location
Code
Common Errors
| Message | Cause |
|---|---|
Order cannot be allotted before 4.0 minutes | Wait 4 minutes after order placement |
state transition not possible | Invalid status transition |
All sandbox endpoints are documented in the Sandbox section of the API reference.
See Callbacks for expected webhook payloads.
Last modified on