Address

Description

The Address object contains all address details. This object can represent a billing address, a shipping address, or both.

Properties

Type

Name

Description

string

FirstName

First name of the user.

string

LastName

Last name of the user.

string

CompanyName

Company or organization name of the user.

Note: When a company name is unavailable, provide the first and last name of the user.

string

Address1

Street address line 1.

string

Address2

Street address line 2.

string

Address3

Street address line 3.

string

Address4

Street address line 4.

string

Address5

Street address line 5.

string

Address6

Street address line 6.

string

City

City of the user.

string

State

State or province of the user.

string

ZipCode

Zip or postal code of the user.

string

Country

Two-character ISO-3166-1 country code.

Examples
  • US for United States
  • CA for Canada

boolean

IsDefault

Indicates whether this is the default address for the user.

string

AddressId

Unique identifier for the address.