Skip to main content
GET
/
shipping-address
/
autocomplete
Autocomplete address
curl --request GET \
  --url https://store.salesive.com/api/v1/shipping-address/autocomplete \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": {
    "suggestions": {
      "results": [
        {
          "formatted": "<string>",
          "address_line1": "<string>",
          "address_line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postcode": "<string>",
          "country": "<string>",
          "country_code": "<string>",
          "lat": 123,
          "lon": 123
        }
      ]
    }
  }
}

​
Request

GET /shipping-address/autocomplete?text=No 1 Eugene&limit=5
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}

​
Headers

HeaderTypeDescription
AuthorizationstringProvide the customer token as Bearer <jwt>.
x-shop-idstringIdentify the shop context.

​
Query parameters

ParameterTypeRequiredDescription
textstringYesPartial address text to search for.
limitintegerNoMaximum number of suggestions to return (default: 5).

​
Successful response

{
  "status": 200,
  "success": true,
  "message": "Address suggestions retrieved",
  "data": {
    "suggestions": {
      "results": [
        {
          "formatted": "No 1 Eugene Oba Street, Enugu, Nigeria",
          "address_line1": "No 1 Eugene Oba Street",
          "address_line2": "Enugu, Enugu State",
          "city": "Enugu",
          "state": "Enugu State",
          "postcode": "400251",
          "country": "Nigeria",
          "lat": 6.4216348975198825,
          "lon": 7.483457659243914
        },
        {
          "formatted": "Eugene Street, Enugu, Nigeria",
          "address_line1": "Eugene Street",
          "address_line2": "Enugu, Enugu State",
          "city": "Enugu",
          "state": "Enugu State",
          "country": "Nigeria",
          "lat": 6.4520,
          "lon": 7.5120
        }
      ]
    }
  }
}
Use this endpoint to provide address autocomplete as users type in address forms. It enhances user experience and reduces address entry errors.

​
Error response

{
  "status": 400,
  "success": false,
  "message": "Search text is required",
  "data": {}
}

Authorizations

​
Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

​
x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

​
x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

​
text
string
required

Partial address text to search for.

​
limit
integer
default:5

Maximum number of suggestions to return (default: 5).

Required range: x >= 1

Response

Address suggestions retrieved.

​
status
integer
required
​
success
boolean
required
​
message
string
required
​
data
object
required