Skip to main content
View Markdown

Address Object

Represents user address data.

type Address implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  firstName: String!
  lastName: String!
  companyName: String!
  streetAddress1: String!
  streetAddress2: String!
  city: String!
  cityArea: String!
  postalCode: String!
  country: CountryDisplay!
  countryArea: String!
  phone: String
  isDefaultShippingAddress: Boolean
  isDefaultBillingAddress: Boolean
}

Fields​

id ● ID!​

The ID of the address.

privateMetadata ● [MetadataItem!]!​

List of private metadata items. Requires staff permissions to access.

privateMetafield ● String​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

metadata ● [MetadataItem!]!​

List of public metadata items. Can be accessed without permissions.

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

firstName ● String!​

The given name of the address.

lastName ● String!​

The family name of the address.

companyName ● String!​

Company or organization name.

streetAddress1 ● String!​

The first line of the address.

streetAddress2 ● String!​

The second line of the address.

city ● String!​

The city of the address.

cityArea ● String!​

The district of the address.

postalCode ● String!​

The postal code of the address.

country ● CountryDisplay!​

The country of the address.

countryArea ● String!​

The country area of the address.

phone ● String​

The phone number assigned the address.

isDefaultShippingAddress ● Boolean​

Address is user's default shipping address.

isDefaultBillingAddress ● Boolean​

Address is user's default billing address.

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Returned By​

address query

Member Of​

AccountAddressCreate object ● AccountAddressDelete object ● AccountAddressUpdate object ● AddressCreate object ● AddressCreated object ● AddressDelete object ● AddressDeleted object ● AddressUpdate object ● AddressUpdated object ● Checkout object ● Order object ● Shop object ● TaxableObject object ● User object ● Warehouse object

Implemented By​

_Entity union