Copy page

Hyperlocal

Sandbox Testing

These APIs are available only in the staging environment. Use them to simulate order flow and test your callback handler without waiting for real rider actions.

Trigger them from the Callback Sandbox Postman Collection or via curl.

Status Update Flow

Simulate the full order lifecycle in this order:

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
curl -X PUT https://hlbackend.staging.shadowfax.in/app/v3/sandbox/clusters/orders/{sfx_order_id}/allot/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{ "rider_id": 136493 }'

Pass "only_allot": 0 to trigger acceptance callback, or "only_allot": 1 for allot callback.

Update Rider Location

Test rider location callbacks:

Code
curl -X PUT https://hlbackend.staging.shadowfax.in/app/v3/sandbox/order/{sfx_order_id}/update-rider-location/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "update_latitude": 12.387487873,
    "update_longitude": 77.78787878
  }'

Common Errors

Message	Cause
Order cannot be allotted before 4.0 minutes	Wait 4 minutes after order placement before allotting
state transition not possible	Invalid status transition for current order state
Failed to update.	Order not in expected state for the requested transition

API Reference

All sandbox endpoints are documented in the Sandbox section of the API reference.

See Callbacks for expected webhook payloads at each status.