---
title: Address Object
seo:
  title: Address Object
  description: 'Object: Address Object'
slug: api-reference/users/objects/address
sidebar:
  label: Address
search:
  tags:
    - API reference
    - Users
lastModified: '2026-04-13'
---

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


## Interfaces

[`Node`](/api-reference/miscellaneous/interfaces/node), [`ObjectWithMetadata`](/api-reference/miscellaneous/interfaces/object-with-metadata)

## Fields

### id [#id]

**`id`** · [`ID!`](/api-reference/miscellaneous/scalars/id)

The ID of the address.
### privateMetadata [#private-metadata]

**`privateMetadata`** · [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item)

List of private metadata items. Requires staff permissions to access.
### privateMetafield [#private-metafield]

**`privateMetafield`** · [`String`](/api-reference/miscellaneous/scalars/string)

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

Tip: Use GraphQL aliases to fetch multiple keys.

#### key [#address-private-metafield-key]

**`key`** · [`String!`](/api-reference/miscellaneous/scalars/string)


### privateMetafields [#private-metafields]

**`privateMetafields`** · [`Metadata`](/api-reference/miscellaneous/scalars/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 [#address-private-metafields-keys]

**`keys`** · [`[String!]`](/api-reference/miscellaneous/scalars/string)


### metadata [#metadata]

**`metadata`** · [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item)

List of public metadata items. Can be accessed without permissions.
### metafield [#metafield]

**`metafield`** · [`String`](/api-reference/miscellaneous/scalars/string)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

#### key [#address-metafield-key]

**`key`** · [`String!`](/api-reference/miscellaneous/scalars/string)


### metafields [#metafields]

**`metafields`** · [`Metadata`](/api-reference/miscellaneous/scalars/metadata)

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

#### keys [#address-metafields-keys]

**`keys`** · [`[String!]`](/api-reference/miscellaneous/scalars/string)


### firstName [#first-name]

**`firstName`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The given name of the address.
### lastName [#last-name]

**`lastName`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The family name of the address.
### companyName [#company-name]

**`companyName`** · [`String!`](/api-reference/miscellaneous/scalars/string)

Company or organization name.
### streetAddress1 [#street-address-1]

**`streetAddress1`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The first line of the address.
### streetAddress2 [#street-address-2]

**`streetAddress2`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The second line of the address.
### city [#city]

**`city`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The city of the address.
### cityArea [#city-area]

**`cityArea`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The district of the address.
### postalCode [#postal-code]

**`postalCode`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The postal code of the address.
### country [#country]

**`country`** · [`CountryDisplay!`](/api-reference/miscellaneous/objects/country-display)

The country of the address.
### countryArea [#country-area]

**`countryArea`** · [`String!`](/api-reference/miscellaneous/scalars/string)

The country area of the address.
### phone [#phone]

**`phone`** · [`String`](/api-reference/miscellaneous/scalars/string)

The phone number assigned the address.
### isDefaultShippingAddress [#is-default-shipping-address]

**`isDefaultShippingAddress`** · [`Boolean`](/api-reference/miscellaneous/scalars/boolean)

Address is user's default shipping address.
### isDefaultBillingAddress [#is-default-billing-address]

**`isDefaultBillingAddress`** · [`Boolean`](/api-reference/miscellaneous/scalars/boolean)

Address is user's default billing address.

## Used by

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

---

Schema: **Saleor 3.23.43**. [Download SDL](/schema/saleor.graphql).
