`IUserAddressListResponse`

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

IUserAddressListResponse

page_data contains separate addresses and countries arrays. Address country/region values are objects, while write requests use their IDs.

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

TypeScript

export interface IUserAddressListResponse {
  // Field errors or __all__ errors; null on success.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message; null on failure.
  success_message: string | null;
  // `page_data` contains separate `addresses` and `countries` arrays. Address
  // country/region values are objects, while write requests use their IDs.
  page_data: {
    // Shipping-country objects. This list is independent of the address
    // filters.
    countries: IAddressCountry[];
    // Value of addresses.
    addresses: IUserAddress[];
  } | null;
}