API ReferenceEndpointsCheckoutGet address autocomplete suggestions

Get address autocomplete suggestions

Address autocomplete predictions for the checkout address field. Call it on every debounced keystroke (up to 60 requests per minute per IP). Send one sessionToken for the whole typing session and pass the same token to checkout/address-details.

GET
/vc/{connectionId}/checkout/address-suggestions
X-Sales-Channel-Origin<token>

For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.

In: header

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

Query Parameters

qstring

Text typed so far. At least 3 characters, otherwise 400.

sessionTokenstring

Autocomplete session token chosen by the storefront (any unique string per typing session). Not a cart token. Required.

lat?number

Latitude of the shopper. With lng, biases the suggestions toward that point.

lng?number

Longitude of the shopper. Used with lat.

Header Parameters

originstring

Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.

accept-language?string

Preferred language, for example he. Its first tag is used when it is one of the store's supported languages other than the default; translated fields are then returned in that language. Falls back to the locale query parameter.

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/checkout/address-suggestions?q=12+Herzl&sessionToken=string&lat=0&lng=0" \  -H "origin: string" \  -H "accept-language: string" \  -H "X-SDK-Version: string"
{
  "suggestions": [
    {
      "placeId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
      "description": "string"
    }
  ]
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/checkout/address-suggestions"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/checkout/address-suggestions"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/checkout/address-suggestions"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/checkout/address-suggestions"
}