Skip to main content

CustomerAddress

type CustomerAddress {
id: ID!
addressLine1: String!
addressLine2: String
attributes: [CustomerAttributeValue!]
city: CustomerAddressCity!
company: String
country: CustomerAddressCountry!
district: CustomerAddressDistrict
firstName: String!
identityNumber: String
isDefault: Boolean
lastName: String!
phone: String
postalCode: String
region: CustomerAddressRegion
state: CustomerAddressState
taxNumber: String
taxOffice: String
title: String!
}

Fields

idID!required
addressLine1String!required

The customer's mailing address.

addressLine2String

An additional field for the customer's mailing address.

The customer's city.

companyString

The customer's company.

The customer's country.

The customer's district in city.

firstNameString!required

The customer's first name.

identityNumberString

The customer's identity numbers.

isDefaultBoolean

Whether this address is the default address for the customer. Returns true for each default address.

lastNameString!required

The customer's last name.

phoneString

The customer's phone number at this address

postalCodeString

The customer's postal code, also known as zip, postcode, etc.

taxNumberString

Tax number that the customer will use for orders

taxOfficeString

If customer is corporate, customer can use that field to fill their Tax Office name.

titleString!required