Skip to main content
GET
Autocomplete address

Request

Headers

Query parameters

Successful response

Use this endpoint to provide address autocomplete as users type in address forms. It enhances user experience and reduces address entry errors.

Error response

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