Talk to an Expert
Coverage lookup - Grasshopper Labs API
DocsRegionsCoverage lookup
Shipping

Coverage lookup

Check whether a ZIP code is covered for a given service level.

GET /api/regions/coverage/

Query parameters

zip
string Required
5-digit US ZIP code to check.
service_level
string Optional
Optional. Filter by a specific service level.
curl -G https://{licensee-url}/api/regions/coverage/ \
  -H "Authorization: Bearer $TOKEN" \
  -d "zip=78701"
{
  "zip": "78701",
  "covered": true,
  "region_id": "southwest",
  "nearest_hub": "hub-aus-02",
  "service_levels": ["wg", "thr", "curb"],
  "transit_days": { "min": 2, "max": 4 }
}
{
  "zip": "99999",
  "covered": false,
  "nearest_hub": null,
  "service_levels": []
}
Try it out
Response will appear here
← Previous
Regions