CustomerAddress

OBJECT

Address that is associated with a customer account.

Fields

entityIdIntegerRequired

Customer address ID.

firstNameStringRequired

First name of the address owner.

lastNameStringRequired

Last name of the address owner.

address1StringRequired

First line for the street address.

cityStringRequired

City.

countryCodeStringRequired

2-letter country code.

formFieldslist of CustomerFormFieldValuesRequired

The form field values of the customer address.

address2StringOptional

Second line for the street address.

addressTypeDestinationAddressTypeOptional

Address type (Residential or Commercial).

Allowed values:

countryStringOptional

Country name.

countryIdIntegerOptional

Country ID as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/countries#get-all-countries).

stateOrProvinceStringOptional

Name of State or Province.

stateIdIntegerOptional

State Id as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/states#get-all-states).

phoneStringOptional

Phone number.

postalCodeStringOptional

Postal code.

companyStringOptional

Company name associated with the address.

Referenced by

Fields