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;
    phone?: string;
    pOBox?: 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? phone? pOBox? postalCode? region? salutation? state? streetName? streetNumber? title?

Properties

Optional ReadonlyadditionalAddressInfo

additionalAddressInfo?: string

Further information on the Address.

Optional ReadonlyadditionalStreetInfo

additionalStreetInfo?: string

Further information on the street address.

Optional Readonlyapartment

apartment?: string

Number or name of the apartment.

Optional Readonlybuilding

building?: string

Number or name of the building.

Optional Readonlycity

city?: string

Name of the city.

Optional Readonlycompany

company?: string

Name of the company.

Readonlycountry

country: string

Name of the country.

Optional Readonlycustom

custom?: Custom

Custom Fields for the address.

Optional Readonlydepartment

department?: string

Name of the department.

Optional Readonlyemail

email?: string

Email address of the contact.

Optional ReadonlyexternalId

externalId?: string

ID for the contact used in an external system.

Optional Readonlyfax

fax?: string

Fax number of the contact.

Optional ReadonlyfirstName

firstName?: string

Given name (first name) of the contact.

Readonlykey

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 ReadonlylastName

lastName?: string

Family name (last name) of the contact.

Optional Readonlymobile

mobile?: string

Mobile phone number of the contact.

Optional Readonlyphone

phone?: string

Phone number of the contact.

Optional ReadonlypOBox

pOBox?: string

Post office box number.

Optional ReadonlypostalCode

postalCode?: string

Postal code.

Optional Readonlyregion

region?: string

Name of the region.

Optional Readonlysalutation

salutation?: string

Salutation of the contact, for example 'Mr.' or 'Ms.'

Optional Readonlystate

state?: string

Name of the state, for example, Colorado.

Optional ReadonlystreetName

streetName?: string

Name of the street.

Optional ReadonlystreetNumber

streetNumber?: string

Street number.

Optional Readonlytitle

title?: string

Title of the contact, for example 'Dr.'

Settings

Member Visibility

On This Page

Properties