Get Mapped Locations
Get Delivery Locations
GET
{baseUrl}/locations
This endpoint allows you to view mapped delivery locations and their location code. Latitude and longitude or location code are required when requesting deliveries.
Query Parameters
Name
Type
Description
country
string
2-letter country code
{
"status": true,
"message": "Locations successfully retrieved",
"data": [
{
"state": "Lagos State",
"locals": [
{
"name": "Ajah",
"locationCode": "01"
}
{
"name": "Ajeromi-Ifelodun",
"locationCode": "02"
},
]
}
]
}
// Sample Response Body - 200 OK
{
"status": true,
"message": "Locations fetched successfully",
"data": [
{
"state": "Abia",
"locals": [
{
"name": "Aba North",
"locationCode": "IZJJ",
"isAvailable": true,
"isLockerAvailable": false
},
//...truncated for brevity
}
Last updated