Application Load
IUserAddressRequest
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
IUserAddressRequestAddress fields for creation and full update.
app/interfaces/orionplace/address/IUserAddress.tsexport interface IUserAddressRequest {
// Required, 3–32 characters. A unique label among the user’s saved addresses.
address_label: string;
// Required street/address line, 2–128 characters.
line1: string;
// Optional additional address line, up to 128 characters.
line2?: string;
// Required city name, up to 128 characters.
city: string;
// Required region ID from `fUserAddress.state`. Select a region belonging to
// the chosen country.
state: number;
// Postal code following the selected country’s rules, up to 64 characters.
postcode?: string;
// Required country ID from `fUserAddress.country`. The form accepts enabled
// countries; shipping availability is a separate country property.
country: number;
// Required house identifier as text, up to 20 characters; letters are
// allowed.
house_number: string;
// Optional entrance, up to 20 characters.
entrance?: string;
// Optional intercom code, up to 20 characters.
intercom?: string;
// Optional floor as text, up to 20 characters.
floor?: string;
// Optional apartment/office identifier, up to 20 characters.
apt_number?: string;
// `true` makes this the shipping default and clears that flag on other
// addresses. Omitted means `false` in the bound form.
is_default_for_shipping?: boolean;
}