entityIdIntegerRequired
The unique ID of the company address.
firstNameStringRequired
First name of the address contact.
lastNameStringRequired
Last name of the address contact.
address1StringRequired
First line of the street address.
countryStringRequired
Full name of the country.
countryCodeStringRequired
ISO 3166-1 alpha-2 country code.
Extra fields defined by the merchant.
address2StringOptional
Second line of the street address.
stateOrProvinceStringOptional
Name of the state or province.
stateOrProvinceCodeStringOptional
State or province code (e.g. “CA” or “NSW”).
phoneStringOptional
Phone number for the address contact.
isDefaultShippingBooleanOptional
Whether this is the default shipping address for the company.
isDefaultBillingBooleanOptional
Whether this is the default billing address for the company.
isBillingBooleanOptional
Whether this address can be used for billing.
isShippingBooleanOptional
Whether this address can be used for shipping.
createdAtDatetimeOptional
When the address was created, or null if unknown.
updatedAtDatetimeOptional
When the address was last updated, or null if unknown.