Company
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 FieldsFields
- Anchor to address1address1•String!non-null
The first line of the address. It is typically the street address or PO Box number.
- Anchor to address2address2•String
The second line of the address. It is typically the apartment, suite, or unit number.
- Anchor to citycity•String
The city, district, village, or town.
- Anchor to companyNamecompany•String!
Name non-null The name of the company.
- Anchor to countrycountry•String
The name of the country of the address.
- Anchor to countryCodecountry•Country
Code Code! non-null The two-letter code for the country of the address, for example, US.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time (in ISO 8601 format) when the company address was created.
- Anchor to firstNamefirst•String
Name The first name of the recipient.
- Anchor to formattedAddressformatted•[String!]!
Address non-null The formatted version of the address.
- Anchor to withNamewith•Boolean
Name Default:false Whether to include the name of the recipient in the formatted address.
- Anchor to withCompanyNamewith•Boolean
Company Name Default:true Whether to include the company name in the formatted address.
Arguments
- Anchor to formattedAreaformatted•String
Area A comma-separated list of the city, province, and country values.
- •ID!non-nullPre-auth accessible
A globally-unique ID.
- Anchor to lastNamelast•String
Name The last name of the recipient.
- Anchor to phonephone•String
The unique phone number of the customer, formatted using the E.164 standard, for example, +16135551111.
- Anchor to provinceprovince•String
The region of the address, such as the province, state, or district.
- Anchor to recipientrecipient•String
The identity of the recipient, for example, 'Receiving Department'.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time (in ISO 8601 format) when the company address was last updated.
- •String
The zip or postal code of the address.
- Anchor to zoneCodezone•String
Code The alphanumeric code for the region, for example, ON.
Anchor to MutationsMutations
- •mutation
Updates an address on a company location.
- Anchor to addressaddress•Company
Address Input! required The input fields to use to update the address.
- Anchor to addressTypesaddress•[Company
Types Address Type!]! required The list of address types on the location to update.
- Anchor to locationIdlocation•ID!
Id required The ID of the company location to update addresses on.
Arguments
- Anchor to addressesaddresses•[Company
Address!] The list of updated addresses on the company location.
- Anchor to userErrorsuser•[Business
Errors Customer User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields