Interface ShippingApiModelV2Address

The address.

Export

Address

interface ShippingApiModelV2Address {
    addressLine1: string;
    addressLine2?: string;
    addressLine3?: string;
    city: string;
    companyName?: string;
    countryCode: string;
    email?: string;
    geocode?: ShippingApiModelV2Geocode;
    name: string;
    phoneNumber?: string;
    postalCode: string;
    stateOrRegion: string;
}

Properties

addressLine1 addressLine2? addressLine3? city companyName? countryCode email? geocode? name phoneNumber? postalCode stateOrRegion

Properties

addressLine1

addressLine1: string

The first line of the address.

Memberof

Address

OptionaladdressLine2

addressLine2?: string

Additional address information, if required.

Memberof

Address

OptionaladdressLine3

addressLine3?: string

Additional address information, if required.

Memberof

Address

city

city: string

The city or town where the person, business or institution is located.

Memberof

Address

OptionalcompanyName

companyName?: string

The name of the business or institution associated with the address.

Memberof

Address

countryCode

countryCode: string

The two digit country code. Follows ISO 3166-1 alpha-2 format.

Memberof

Address

Optionalemail

email?: string

The email address of the contact associated with the address.

Memberof

Address

Optionalgeocode

geocode?: ShippingApiModelV2Geocode

Memberof

Address

name

name: string

The name of the person, business or institution at the address.

Memberof

Address

OptionalphoneNumber

phoneNumber?: string

The phone number of the person, business or institution located at that address, including the country calling code.

Memberof

Address

postalCode

postalCode: string

The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.

Memberof

Address

stateOrRegion

stateOrRegion: string

The state, county or region where the person, business or institution is located.

Memberof

Address

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR