addressSuggest

Queryin Address suggest

Addresses matching what the buyer has typed so far, for a search box that suggests as they type. Resolve the chosen one with addressResolve.

Pass the same session from the first keystroke to the resolve, for a source that bills a search as one session; one that does not, ignores it. An empty list means nothing matches. Null means the source does not cover the country, or it is unavailable.

Arguments

Argument	Type	Description
country	CountryCode!
query	String!
session	String

Returns

[AddressSuggestion!]

Field	Type	Description
id	ID!	Opaque; pass it to addressResolve
label	String!	The address as the buyer reads it in a list
city	String
country	CountryCode
streetNumber	String
streetNumberSuffix	String
postalCode	String
streetName	String

Example

Query

query AddressSuggest($country: CountryCode!, $query: String!, $session: String) {
  addressSuggest(country: $country, query: $query, session: $session) {
    id
    label
    city
    country
    streetNumber
    streetNumberSuffix
    postalCode
    streetName
  }
}

Variables

{
  "country": "NL",
  "query": "Example",
  "session": "Example"
}

Response

{
  "data": {
    "addressSuggest": [
      {
        "id": "id-1",
        "label": "Example",
        "city": "Example",
        "country": "NL",
        "streetNumber": "Example",
        "streetNumberSuffix": "Example",
        "postalCode": "Example",
        "streetName": "Example"
      }
    ]
  }
}

The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.

Used by

The storefront packages that send it, in these GraphQL documents:

• @evolve-storefront/commerce-ui: CommerceAddressSuggest