`IAddressCitySuggestionRequest`

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

IAddressCitySuggestionRequest

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

src/lib/interfaces/orionplace/address/IAddressCitySuggestion.ts

TypeScript

export interface IAddressCitySuggestionRequest {
  // 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 search text, up to 120 characters; spaces at the edges are
  // removed, and spaces only count as empty. One letter is enough.
  search_string: string;
}