Interface CustomerAddress

Different from Address in that key is required and id is not supported.

interface CustomerAddress {
    additionalAddressInfo?: string;
    additionalStreetInfo?: string;
    apartment?: string;
    building?: string;
    city?: string;
    company?: string;
    country: string;
    custom?: Custom;
    department?: string;
    email?: string;
    externalId?: string;
    fax?: string;
    firstName?: string;
    key: string;
    lastName?: string;
    mobile?: string;
    pOBox?: string;
    phone?: string;
    postalCode?: string;
    region?: string;
    salutation?: string;
    state?: string;
    streetName?: string;
    streetNumber?: string;
    title?: string;
}

Properties

additionalAddressInfo? additionalStreetInfo? apartment? building? city? company? country custom? department? email? externalId? fax? firstName? key lastName? mobile? pOBox? phone? postalCode? region? salutation? state? streetName? streetNumber? title?

Properties

Optional Readonly additionalAddressInfo

additionalAddressInfo?: string

Optional Readonly additionalStreetInfo

additionalStreetInfo?: string

Optional Readonly apartment

apartment?: string

Optional Readonly building

building?: string

Optional Readonly city

city?: string

Optional Readonly company

company?: string

Readonly country

country: string

A two-digit country code as per ISO 3166-1 alpha-2.

Optional Readonly custom

custom?: Custom

Custom Fields for the address.

Optional Readonly department

department?: string

Optional Readonly email

email?: string

Optional Readonly externalId

externalId?: string

Optional Readonly fax

fax?: string

Optional Readonly firstName

firstName?: string

Readonly key

key: string

User-defined identifier for the address. Must follow the pattern [a-zA-Z0-9_\-]{2,256} and must be unique per customer.

Optional Readonly lastName

lastName?: string

Optional Readonly mobile

mobile?: string

Optional Readonly pOBox

pOBox?: string

Optional Readonly phone

phone?: string

Optional Readonly postalCode

postalCode?: string

Optional Readonly region

region?: string

Optional Readonly salutation

salutation?: string

Optional Readonly state

state?: string

Optional Readonly streetName

streetName?: string

Optional Readonly streetNumber

streetNumber?: string

Optional Readonly title

title?: string

Settings

Member Visibility

Theme

On This Page

additionalAddressInfoadditionalStreetInfoapartmentbuildingcitycompanycountrycustomdepartmentemailexternalIdfaxfirstNamekeylastNamemobilepOBoxphonepostalCoderegionsalutationstatestreetNamestreetNumbertitle