`IAddressSuggestionRequest`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IAddressSuggestionRequest

Required location and text fields for suggestion lookup, at the JSON root.

app/interfaces/orionplace/address/IAddressSuggestion.ts

TypeScript

export interface IAddressSuggestionRequest {
  // Required country ID: the `value` of an option with `suggestions: true` from
  // `reload_customer_app`, as a number or a numeric string. A country without
  // suggestions returns «Select a valid choice. That choice is not one of the
  // available choices.».
  country: number | string;
  // Required region ID of the selected country. A region of another country
  // returns «Region does not belong to the selected country.» in
  // `form_errors.region`.
  region: number | string;
  // Required city name, up to 128 characters, usually the `city` of an
  // `address_hints_suggest_city` suggestion.
  city: string;
  // Required street search text, up to 120 characters; spaces at the edges are
  // removed. Search by street name: a house number does not narrow the result.
  address_string: string;
}