Interface Address

Shipping address that represents the origin or destination location.

Export

Address

interface Address {
    addressLine1: string;
    addressLine2?: string;
    addressLine3?: string;
    city?: string;
    countryCode: string;
    county?: string;
    district?: string;
    name: string;
    phoneNumber?: string;
    postalCode?: string;
    stateOrRegion: string;
}

Properties

addressLine1 addressLine2? addressLine3? city? countryCode county? district? name phoneNumber? postalCode? stateOrRegion

Properties

addressLine1

addressLine1: string

First line of the address text.

Memberof

Address

OptionaladdressLine2

addressLine2?: string

Optional second line of the address text.

Memberof

Address

OptionaladdressLine3

addressLine3?: string

Optional third line of the address text.

Memberof

Address

Optionalcity

city?: string

Optional city where this address is located.

Memberof

Address

countryCode

countryCode: string

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

Memberof

Address

Optionalcounty

county?: string

Optional county where this address is located.

Memberof

Address

Optionaldistrict

district?: string

Optional district where this address is located.

Memberof

Address

name

name: string

Name of the person, business, or institution at this address.

Memberof

Address

OptionalphoneNumber

phoneNumber?: string

Optional E.164-formatted phone number for an available contact at this address.

Memberof

Address

OptionalpostalCode

postalCode?: string

Optional postal code where this address is located.

Memberof

Address

stateOrRegion

stateOrRegion: string

State or region where this address is located. Note that this is contextual to the specified country code.

Memberof

Address

Settings

Member Visibility

On This Page

Properties