Interface AddressExtendedFields

The container for address extended fields. For example, street name or street number. Only available for Brazil shipping addresses as of now.

Export

AddressExtendedFields

interface AddressExtendedFields {
    Complement?: string;
    Neighborhood?: string;
    StreetName?: string;
    StreetNumber?: string;
}

Properties

Complement? Neighborhood? StreetName? StreetNumber?

Properties

Optional Complement

Complement?: string

The floor number/unit number in the building/private house number.

Memberof

AddressExtendedFields

Optional Neighborhood

Neighborhood?: string

The neighborhood. It's smaller than a region and an integral part of an address. It is used in some countries like Brazil.

Memberof

AddressExtendedFields

Optional StreetName

StreetName?: string

The street name.

Memberof

AddressExtendedFields

Optional StreetNumber

StreetNumber?: string

The house number/building number/property number in the street.

Memberof

AddressExtendedFields

Settings

Member Visibility

Theme

On This Page

ComplementNeighborhoodStreetNameStreetNumber