Hyperlocal

Serviceability

Before placing an order, run a serviceability check. Only when the response returns serviceable: true should you create the order — and do so within a couple of minutes of the check.

Rate limit: 1200 requests per minute.

Request

Code
curl -X PUT https://hlbackend.staging.shadowfax.in/api/v1/order-serviceability/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "pickup_latitude": "12.9276526",
    "pickup_longitude": "77.5620661",
    "drop_latitude": "12.897338",
    "drop_longitude": "77.552905",
    "paid": "false",
    "COID": "order_23434",
    "stage_of_check": "post_order",
    "order_value": 250,
    "rain_flag": false,
    "client_surge": 0.0
  }'

Fields

Field	Required	Description
`pickup_latitude`	Yes	Pickup latitude (string, converted to float)
`pickup_longitude`	Yes	Pickup longitude (string, converted to float)
`drop_latitude`	Yes	Drop latitude (string, converted to float)
`drop_longitude`	Yes	Drop longitude (string, converted to float)
`paid`	Yes	`"false"` for COD, `"true"` for prepaid
`order_value`	Yes	Order value
`COID`	No	Client order ID for mapping
`stage_of_check`	No	`"pre_order"` or `"post_order"`
`rain_flag`	No	Pass `true` if rain-impacted
`client_surge`	No	Extra surge incentive for the rider

Response

When serviceable:


Code
{
  "serviceable": true,
  "pickup_eta": 10,
  "drop_eta": 35,
  "delivery_cost": 42,
  "pickup_rain_mode_flag": false,
  "drop_rain_mode_flag": false,
  "rain_surge_amount": 0
}

When not serviceable (e.g. no riders available):


Code
{
  "reason": "NO_FREE_RIDER_AVAILABLE_PLEASE_TRY_AGAIN_IN_SOME_TIME.",
  "serviceability": false,
  "delivery_cost": 78.0,
  "serviceable": false
}

Error Responses

HTTP	Message	Cause
400	`Empty Pickup Lat/Long.`	Missing pickup coordinates
400	`Order in non-serviceable area`	Location outside coverage
401	`Invalid token`	Authentication failed

See the Serviceability API for the full schema.

Last modified on August 2, 2026

Order Lifecycle Orders

Request

Code

curl -X PUT https://hlbackend.staging.shadowfax.in/api/v1/order-serviceability/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "pickup_latitude": "12.9276526",
    "pickup_longitude": "77.5620661",
    "drop_latitude": "12.897338",
    "drop_longitude": "77.552905",
    "paid": "false",
    "COID": "order_23434",
    "stage_of_check": "post_order",
    "order_value": 250,
    "rain_flag": false,
    "client_surge": 0.0
  }'

Fields

Field

Required

Description

pickup_latitude

Yes

Pickup latitude (string, converted to float)

pickup_longitude

Yes

Pickup longitude (string, converted to float)

drop_latitude

Yes

Drop latitude (string, converted to float)

drop_longitude

Yes

Drop longitude (string, converted to float)

paid

Yes

"false" for COD, "true" for prepaid

order_value

Yes

Order value

COID

Client order ID for mapping

stage_of_check

"pre_order" or "post_order"

rain_flag

Pass true if rain-impacted

client_surge

Extra surge incentive for the rider

Response

When serviceable:

Code

{
  "serviceable": true,
  "pickup_eta": 10,
  "drop_eta": 35,
  "delivery_cost": 42,
  "pickup_rain_mode_flag": false,
  "drop_rain_mode_flag": false,
  "rain_surge_amount": 0
}

When not serviceable (e.g. no riders available):

Code

{
  "reason": "NO_FREE_RIDER_AVAILABLE_PLEASE_TRY_AGAIN_IN_SOME_TIME.",
  "serviceability": false,
  "delivery_cost": 78.0,
  "serviceable": false
}

HTTP

Message

Cause

400

Empty Pickup Lat/Long.

Missing pickup coordinates

400

Order in non-serviceable area

Location outside coverage

401

Invalid token

Authentication failed