Docs
Dashboard

AddressPrediction

Object

A single address autocomplete suggestion.

#

Fields


addressId
String!

Opaque identifier for the predicted address. Pass this back to addressDetails to resolve a structured address.

completionService
String!

Name of the provider that produced this completion (e.g. “google”).

description
String!

Human-readable description of the predicted address (e.g. “Gardes Allé, Hellerup, Denmark”).

matchedSubstrings
[AddressPredictionMatchedSubstring!]!

Offsets within Description that matched the user query — used to bold the matched portion in the UI.

#

Queries


Returns address autocomplete suggestions matching query. sessionToken is the composite token {checkoutToken}-{googleSessionToken}: the checkout-token half is validated against an active hosted checkout session; the Google-session half is forwarded verbatim to Google so the client controls billing- session lifetime (a new one per place-details resolution).