Address

An address is a postal address for a specific customer. A customer can have up to 2 different types of addresses. If a customer has only one address, that is what is returned. Mailing address is only required if different from residential address.

address Object

Property

Data Type (length)

Description

addressLine1

string (100)

Customer residential address line 1

addressLine2

string (100)

Customer residential address line 2

addressLine3

string (100)

Customer residential address line 3

addressLine4

string (100)

Customer residential address line 4

addressType

enum

Type of customer address

Valid values include:

  • Residence: A physical address is required; P.O. boxes are not accepted.
  • Mailing: Required only if different from the Residence address.
  • PrimaryBusiness*: Primary physical location for the business; P.O boxes are not accepted. Required for all business customers.
  • Business*: Additional business location
  • Registered*: Address where the business was registered
  • TaxFormMailing*: Address where tax forms should be sent. Only required if different from primary address or mailing address

*Values are only used for business customers

city

string (50)

Customer address city

country

string (2)

Must be US

isActive

boolean

Indicates whether the customer address is currently active

postalCode

string (9)

Customer address postal code
U.S. numbers only, without hyphen

state

string (2)

Two-character code for U.S. state of customer address

Example: CA