Address

Represents a physical or shipping address within the store system.

Type Definition


type Address {
  name: String
  email: String
  firstName: String
  lastName: String
  company: String
  companyId: String
  vatNumber: String
  vatId: String
  phone: String
  address1: String
  address2: String
  zipcode: String
  city: String
  stateCode: String
  countryCode: String
  info: String
  latitude: String
  longitude: String
}

Fields

Field	Type	Description
name	String	Full name of the person associated with this address
email	String	Email address for contact purposes
firstName	String	Returns the value of first_name field in the address
lastName	String	Last name of the person
company	String	Company name associated with this address
companyId	String	Business ID of the company
vatNumber	String	VAT identification number
vatId	String	VAT identification number
phone	String	Returns the value of phone field in the address
address1	String	Returns the value of address1 field in the address
address2	String	Returns the value of address2 field in the address
zipcode	String	Returns the value of zipcode field in the address
city	String	Returns the value of city field in the address
stateCode	String	Returns the value of state_code field in the address
countryCode	String	Returns the value of country_code field in the address
info	String	Additional information or notes for the address
latitude	String	Latitude coordinate of the address
longitude	String	Longitude coordinate of the address

Relationships

The Address type is used in several contexts throughout the API. It serves as the shipping address and billing address for Cart objects, the address associated with Customer objects, and the pickup address for CartShippingMethod selections. Merchant objects also utilize Address to store business location information.

Example


query {
  customer {
    address {
      name
      email
      firstName
      lastName
      company
      phone
      address1
      address2
      zipcode
      city
      stateCode
      countryCode
    }
  }
}

Implements

None