> Documentation index: [Saleor](/llms.txt) · [This section](/api-reference/users/llms.txt)
> Source: https://docs.saleor.io/api-reference/users/objects/address

# Address Object

Represents user address data.

```graphql
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
}
```

<a id="fields"></a>

### Fields

<a id="id"></a>

#### [`id`](#id) ● [`ID!`](/api-reference/miscellaneous/scalars/id.md)

The ID of the address.

<a id="private-metadata"></a>

#### [`privateMetadata`](#private-metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

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

<a id="private-metafield"></a>

#### [`privateMetafield`](#private-metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

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

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="address-private-metafield-key"></a>

##### [`key`](#address-private-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="private-metafields"></a>

#### [`privateMetafields`](#private-metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

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

<a id="address-private-metafields-keys"></a>

##### [`keys`](#address-private-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="metadata"></a>

#### [`metadata`](#metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

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

<a id="metafield"></a>

#### [`metafield`](#metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="address-metafield-key"></a>

##### [`key`](#address-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="metafields"></a>

#### [`metafields`](#metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

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

<a id="address-metafields-keys"></a>

##### [`keys`](#address-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="first-name"></a>

#### [`firstName`](#first-name) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The given name of the address.

<a id="last-name"></a>

#### [`lastName`](#last-name) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The family name of the address.

<a id="company-name"></a>

#### [`companyName`](#company-name) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Company or organization name.

<a id="street-address-1"></a>

#### [`streetAddress1`](#street-address-1) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The first line of the address.

<a id="street-address-2"></a>

#### [`streetAddress2`](#street-address-2) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The second line of the address.

<a id="city"></a>

#### [`city`](#city) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The city of the address.

<a id="city-area"></a>

#### [`cityArea`](#city-area) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The district of the address.

<a id="postal-code"></a>

#### [`postalCode`](#postal-code) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The postal code of the address.

<a id="country"></a>

#### [`country`](#country) ● [`CountryDisplay!`](/api-reference/miscellaneous/objects/country-display.md)

The country of the address.

<a id="country-area"></a>

#### [`countryArea`](#country-area) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

The country area of the address.

<a id="phone"></a>

#### [`phone`](#phone) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

The phone number assigned the address.

<a id="is-default-shipping-address"></a>

#### [`isDefaultShippingAddress`](#is-default-shipping-address) ● [`Boolean`](/api-reference/miscellaneous/scalars/boolean.md)

Address is user's default shipping address.

<a id="is-default-billing-address"></a>

#### [`isDefaultBillingAddress`](#is-default-billing-address) ● [`Boolean`](/api-reference/miscellaneous/scalars/boolean.md)

Address is user's default billing address.

<a id="interfaces"></a>

### Interfaces

<a id="node"></a>

#### [`Node`](/api-reference/miscellaneous/interfaces/node.md)

An object with an ID

<a id="objectwithmetadata"></a>

#### [`ObjectWithMetadata`](/api-reference/miscellaneous/interfaces/object-with-metadata.md)

<a id="returned-by"></a>

### Returned By

[`address`](/api-reference/users/queries/address.md) query

<a id="member-of"></a>

### Member Of

[`AccountAddressCreate`](/api-reference/users/objects/account-address-create.md) object  ● [`AccountAddressDelete`](/api-reference/users/objects/account-address-delete.md) object  ● [`AccountAddressUpdate`](/api-reference/users/objects/account-address-update.md) object  ● [`AddressCreate`](/api-reference/users/objects/address-create.md) object  ● [`AddressCreated`](/api-reference/users/objects/address-created.md) object  ● [`AddressDelete`](/api-reference/users/objects/address-delete.md) object  ● [`AddressDeleted`](/api-reference/users/objects/address-deleted.md) object  ● [`AddressUpdate`](/api-reference/users/objects/address-update.md) object  ● [`AddressUpdated`](/api-reference/users/objects/address-updated.md) object  ● [`Checkout`](/api-reference/checkout/objects/checkout.md) object  ● [`Order`](/api-reference/orders/objects/order.md) object  ● [`Shop`](/api-reference/miscellaneous/objects/shop.md) object  ● [`TaxableObject`](/api-reference/taxes/objects/taxable-object.md) object  ● [`User`](/api-reference/users/objects/user.md) object  ● [`Warehouse`](/api-reference/products/objects/warehouse.md) object

<a id="implemented-by"></a>

### Implemented By

[`_Entity`](/api-reference/miscellaneous/unions/entity.md) union
