Coverage

Coverage for the Hub

GET /hub/coverage

Use this api to get the area a particular hub covers by providing the api key and the details of the coverage - name of the city, latitude and longitude to get the serviceability. Entering the hub name lists the pincodes that it covers while providing the latitude and longitude should provide the polygonal area covered by the hub. NOTE: If name of the hub is not provided, then latitude and longitude are mandatory.

Query Parameters

Name	Type	Description
hub	string	Name of the hub
latitude	number	Latitude of delivery address
longitude	number	Longitude of delivery address

Headers

Name	Type	Description
API_KEY	string	Enter the API Key

200 Returns coverage of the given hub

{
  "status": "SUCCESS",
  "message": {
    "type": "Feature",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          79.6077403841797,
          13.859221792371132
        ],
        [
          80.1350841341797,
          13.303910339793507
        ],
        [
          79.9812755404297,
          12.961543047963888
        ],
        [
          79.4978771029297,
          12.618704246404995
        ],
        [
          79.6077403841797,
          13.859221792371132
        ]
      ]
    }
  }
}

400 When fails to find hub by given name or location falls outside coverage area

No hub with the given name

{
  "status": "FAIL",
  "message": "Hub with name 'Bellandur' doesn't exists"
}

Location out of service

{
  "status": "FAIL",
  "message": "Location is out of coverage area"
}

401 Unauthorized / Wrong api key

{
  "status": "string",
  "message": "string"
}

500 Unexpected Error

{
  "status": "string",
  "message": "string"
}