Skip to main content

Documentation Portal

AddressDetails

Parameter Name

Type

Description

Mandatory

Address1

String

Address line 1.

No

Address2

String

Address line 2.

No

AddressBookId

String

Id of the current address from within the address book

No

AddressBookName

String

Name of the current address from within the address book

No

City

String

City name.

No

Company

String

Company name

No

CountryCode

String

2-char ISO country code

No

Email

String

E-mail address

No

Fax

String

Fax

No

FirstName

String

First name

No

FirstNameInLocalCulture

String

First name in local culture

No

IsBilling

Boolean

Indicates that the current address can be used as a billing address

No

IsDefaultBilling

Boolean

Indicates that the current address is the default billing address

No

IsDefaultShipping

Boolean

Indicates that the current address is the default shipping address

No

IsShipping

Boolean

Indicates that the current address can be used as a shipping address

No

LastName

String

Last name

No

LastNameInLocalCulture

String

Last name in local culture

No

MiddleName

String

Middle name

No

Phone1

String

Phone #1

No

Phone2

String

Phone #2

No

Salutation

String

Salutation or title (e.g. Dr., Mr., etc.).

No

StateCode

String

State or province ISO code such as AZ for Arizona (if applicable)

No

StateOrProvince

String

State or province name

No

UserIdNumber

String

User’s personal ID document number

No

UserIdNumberType

Object UserIdNumberType

User’s personal ID document type (e.g. Passport, ID card, etc.)

No

Zip

String

Zip or postal code

No