Application Load

IUserAddress

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

IUserAddress

Saved customer address.

interfaces/orionplace/address/IUserAddress.ts
TypeScript
export interface IUserAddress {
  // Saved address ID.
  id: number;
  // Address label.
  address_label: string;
  // Saved first address line.
  line1: string;
  // Saved additional address line.
  line2: string;
  // Saved city name.
  city: string;
  // Region object with `id`, `locales`, country code, `country_id` and
  // `region_iso`; nullable.
  state: IAddressRegion | null;
  // Saved postcode.
  postcode: string;
  // Country object with ID, ISO codes, translated `locale.printable_name` and
  // `is_shipping_country`; nullable.
  country: IAddressCountry | null;
  // House identifier.
  house_number: string;
  // Entrance, or an empty string.
  entrance: string;
  // Intercom code, or an empty string.
  intercom: string;
  // Floor, or an empty string.
  floor: string;
  // Apartment/office identifier, or an empty string.
  apt_number: string;
  // Whether this is the shipping default.
  is_default_for_shipping: boolean;
  // Whether this is the default billing address. The address creation and
  // editing forms do not change this field.
  is_default_for_billing: boolean;
}