Serviceability

Before placing an order, run a serviceability check for your store. Place the order within a couple of minutes of a successful check.

Drop latitude and longitude are optional. If not provided, delivery cost will not be calculated.

Rate limit: 1200 requests per minute.

Request

Code
curl -X PUT https://hlbackend.staging.shadowfax.in/api/v2/store_serviceability/ \
  -H "Authorization: Token your_api_token" \
  -H "Content-Type: application/json" \
  -d '{
    "store_code": "STORE_CODE",
    "COID": "order_2345",
    "paid": "false",
    "stage_of_check": "pre_order",
    "drop_latitude": 17.257465,
    "drop_longitude": 78.085492,
    "order_value": 250,
    "rain_flag": false
  }'

Fields

Response

When riders are available:

Code
{
  "available_rider_count": 1,
  "busy_rider_count": 6,
  "pickup_rain_mode_flag": false,
  "drop_rain_mode_flag": false,
  "rain_surge_amount": 0
}

When no riders are available:

Code
{
  "reason": "NO_FREE_RIDER_AVAILABLE_PLEASE_TRY_AGAIN_IN_SOME_TIME.",
  "busy_rider_count": 0,
  "available_rider_count": 0,
  "delivery_cost": 59.0
}

Error Responses

See the Serviceability API for the full schema.