Location Search

Search and autocomplete addresses using a freeform query string. Returns a list of matching place candidates, each with a Google Maps Place ID you can pass directly into shipment creation and pricing endpoints.

---

Endpoint

GET/v1/location

Required permission: location:get

---

Query Parameters

Parameter	Type	Required	Description
q	String	✅	Address or city search string (e.g. "Ikeja", "Ring Road Ibadan").

---

This is only for ease, Debounce the search on user side to avoid rate limit or interuption of this endpoint in the future

Response

Returns an array of address candidates.

Field	Type	Description
placeId	String	Google Maps Place ID. Pass this as senderPlaceId or receiverPlaceId when creating a shipment, or as originPlaceId / destPlaceId when getting a quote.
description	String	Human-readable address string (e.g. "Ikeja, Lagos, Nigeria").

---

How to Use This in a Booking Flow

1. Call GET /v1/location?q=Ikeja as the user types. display the description values as autocomplete suggestions.
2. When the user selects one, store its placeId.
3. Pass that placeId into POST /v1/shipments or POST /v1/shipments/calculate-rates.

The backend resolves the full address, city, state, and coordinates from the Place ID automatically.

---

{
"statusCode": 200,
"message": "Success",
"data": [
  {
    "placeId": "ChIJi4eLcz4OdkgRlgpAD5e4OCg",
    "description": "Ikeja, Lagos, Nigeria"
  },
  {
    "placeId": "ChIJK3V0TvQOdkgRsEMAtlsE7v4",
    "description": "Ikeja City Mall, Obafemi Awolowo Way, Ikeja, Lagos, Nigeria"
  }
]
}