Address

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

Address.id ● ID! non-null scalar

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

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

Added in Saleor 3.10

This API is currently in Feature Preview and can be subject to changes at later point.

Address.privateMetafield ● String scalar

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.10

This API is currently in Feature Preview and can be subject to changes at later point.

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

Address.privateMetafields ● Metadata scalar

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

Added in Saleor 3.10

This API is currently in Feature Preview and can be subject to changes at later point.

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

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

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

Added in Saleor 3.10

This API is currently in Feature Preview and can be subject to changes at later point.

Address.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.10

This API is currently in Feature Preview and can be subject to changes at later point.

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

Address.metafields ● Metadata scalar

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

Added in Saleor 3.10

This API is currently in Feature Preview and can be subject to changes at later point.

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

Address.firstName ● String! non-null scalar

Address.lastName ● String! non-null scalar

Address.companyName ● String! non-null scalar

Address.streetAddress1 ● String! non-null scalar

Address.streetAddress2 ● String! non-null scalar

Address.city ● String! non-null scalar

Address.cityArea ● String! non-null scalar

Address.postalCode ● String! non-null scalar

Address.country ● CountryDisplay! non-null object

Shop's default country.

Address.countryArea ● String! non-null scalar

Address.phone ● String scalar

Address.isDefaultShippingAddress ● Boolean scalar

Address is user's default shipping address.

Address.isDefaultBillingAddress ● Boolean scalar

Address is user's default billing address.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

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