Shadowfax Hyperlocal Marketplace API
string · requiredstring · requiredstring · requiredstring · requiredstring · enum · requirednumber · requiredstringstring · enumbooleannumberbooleannumbernumbernumberbooleanbooleannumberstringboolean
Check whether Shadowfax can serve an order before placement.
Check order serviceability
PUT
https://hlbackend.staging.shadowfax.in
/api/v1/order-serviceability/
Authorization (header)
or
Bearer
Check whether Shadowfax can serve the order. Only when the response is serviceable: true should you place an order — do so within a couple of minutes of the check.
Rate limit: 1200 requests per minute.
Check order serviceability › Request Body
pickup_latitudePickup latitude (converted to float).
pickup_longitudePickup longitude (converted to float).
drop_latitudeDrop latitude (converted to float).
drop_longitudeDrop longitude (converted to float).
paidfalse for COD, true for prepaid.
Enum values:
true
false
order_valueOrder value.
COIDClient order ID for mapping.
stage_of_checkpre_order or post_order.
Enum values:
pre_order
post_order
rain_flagPass true if rain-impacted.
client_surgeExtra surge incentive for the rider.
Check order serviceability › Responses
Serviceability result
serviceabledelivery_costEstimated delivery cost including GST.
pickup_etaPickup ETA in minutes.
drop_etaDrop ETA in minutes.
pickup_rain_mode_flagdrop_rain_mode_flagrain_surge_amountreasonReason when not serviceable.
serviceability