The address of a company location, either billing or shipping. Apps using the Customer Account API must meet the protected customer data requirements.


Anchor to CompanyAddress.address1
address1
Learn more about accessing protected customer data
non-null

The first line of the address. It is typically the street address or PO Box number.

Anchor to CompanyAddress.address2
address2
Learn more about accessing protected customer data

The second line of the address. It is typically the apartment, suite, or unit number.

The city, district, village, or town.

Anchor to CompanyAddress.companyName
companyName
Learn more about accessing protected customer data
non-null

The name of the company.

The name of the country of the address.

The two-letter code for the country of the address, for example, US.

The date and time (in ISO 8601 format) when the company address was created.

Anchor to CompanyAddress.firstName
firstName
Learn more about accessing protected customer data

The first name of the recipient.

Anchor to CompanyAddress.formattedAddress
formattedAddress
Learn more about accessing protected customer data
non-null

The formatted version of the address.

A comma-separated list of the city, province, and country values.

Anchor to CompanyAddress.lastName
lastName
Learn more about accessing protected customer data

The last name of the recipient.

Anchor to CompanyAddress.phone
phone
Learn more about accessing protected customer data

The unique phone number of the customer, formatted using the E.164 standard, for example, +16135551111.

The region of the address, such as the province, state, or district.

Anchor to CompanyAddress.recipient
recipient
Learn more about accessing protected customer data

The identity of the recipient, for example, 'Receiving Department'.

The date and time (in ISO 8601 format) when the company address was last updated.

Anchor to CompanyAddress.zip
zip
Learn more about accessing protected customer data

The zip or postal code of the address.

The alphanumeric code for the region, for example, ON.


Was this section helpful?
Map

Fields from

{}CompanyAddress


Updates an address on a company location.


Was this section helpful?
<~>CompanyAddress Mutations
{}CompanyAddress



Was this section helpful?
||-CompanyAddress Implements
{}CompanyAddress

Implements