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
}

Expand ▼

Fields

Address.id ● ID! non-null scalar miscellaneous

The ID of the address.

Address.privateMetadata ● [MetadataItem!]! non-null object miscellaneous

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

Address.privateMetafield ● String scalar miscellaneous

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

Tip: Use GraphQL aliases to fetch multiple keys.

Address.privateMetafield.key ● String! non-null scalar miscellaneous

Address.privateMetafields ● Metadata scalar miscellaneous

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

Address.privateMetafields.keys ● [String!] list scalar miscellaneous

Address.metadata ● [MetadataItem!]! non-null object miscellaneous

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

Address.metafield ● String scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Address.metafield.key ● String! non-null scalar miscellaneous

Address.metafields ● Metadata scalar miscellaneous

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

Address.metafields.keys ● [String!] list scalar miscellaneous

Address.firstName ● String! non-null scalar miscellaneous

The given name of the address.

Address.lastName ● String! non-null scalar miscellaneous

The family name of the address.

Address.companyName ● String! non-null scalar miscellaneous

Company or organization name.

Address.streetAddress1 ● String! non-null scalar miscellaneous

The first line of the address.

Address.streetAddress2 ● String! non-null scalar miscellaneous

The second line of the address.

Address.city ● String! non-null scalar miscellaneous

The city of the address.

Address.cityArea ● String! non-null scalar miscellaneous

The district of the address.

Address.postalCode ● String! non-null scalar miscellaneous

The postal code of the address.

Address.country ● CountryDisplay! non-null object miscellaneous

The country of the address.

Address.countryArea ● String! non-null scalar miscellaneous

The country area of the address.

Address.phone ● String scalar miscellaneous

The phone number assigned the address.

Address.isDefaultShippingAddress ● Boolean scalar miscellaneous

Address is user's default shipping address.

Address.isDefaultBillingAddress ● Boolean scalar miscellaneous

Address is user's default billing address.

Interfaces

Node interface miscellaneous

An object with an ID

ObjectWithMetadata interface miscellaneous

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