Skip to main content

Coverage

Reeds picks up and delivers anywhere in Lagos State. Each address is checked when it is saved: an address in Lagos State is serviceable: true, and one anywhere else is serviceable: false. A quote also needs a road route between the two addresses.

GET /coverage lists the states where Reeds picks up and delivers, the zones it works in, and the state-to-state routes. It needs no body.

curl https://api.getreeds.co/shipping/v1/coverage \
  -H "Authorization: Bearer $REEDS_ACCESS_TOKEN"
Response 200
{
  "status": "success",
  "data": {
    "states": [
      { "state": "Lagos", "pickup": true, "delivery": true, "zones": ["Ikeja", "Lekki", "Yaba", "..."] }
    ],
    "interstate": [
      { "from": "Lagos", "to": "FCT", "promise": "3-5 working days", "available": false }
    ]
  }
}

Fields​

FieldDescription
states[].stateThe state name
states[].pickuptrue if Reeds collects parcels in this state
states[].deliverytrue if Reeds delivers parcels in this state
states[].zonesThe areas Reeds works in, for display. Reeds doesn't check an address against this list, and its names don't always match an address's location.lga.
interstate[].from, interstate[].toThe two ends of a state-to-state route
interstate[].promiseThe delivery time for that route
interstate[].availableWhether you can book that route through the API

Using coverage​

  • At checkout. Show or hide Reeds as a delivery option. Check the drop-off's state against this list, or just send a quote: an address outside coverage returns available: false with the reason ADDRESS_NOT_SERVICEABLE.
  • When saving addresses. Every saved address is checked against coverage and carries serviceable: true or false. See Addresses.
  • Caching. Coverage changes rarely. Fetch it once a day rather than on every page view.
Inter-state delivery is not available through the API

The Lagos to FCT route is listed with available: false. A quote on an inter-state route returns available: false with the reason INTERSTATE_NOT_AVAILABLE. Reeds adds fields and values to this response over time, so ignore any you don't recognise.

Next steps​