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
}Interfaces
Fields
id
id · ID!
The ID of the address.
privateMetadata
privateMetadata · [MetadataItem!]!
List of private metadata items. Requires staff permissions to access.
privateMetafield
privateMetafield · String
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
key
key · String!
privateMetafields
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
keys · [String!]
metadata
metadata · [MetadataItem!]!
List of public metadata items. Can be accessed without permissions.
metafield
metafield · String
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
key
key · String!
metafields
metafields · Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys
keys · [String!]
firstName
firstName · String!
The given name of the address.
lastName
lastName · String!
The family name of the address.
companyName
companyName · String!
Company or organization name.
streetAddress1
streetAddress1 · String!
The first line of the address.
streetAddress2
streetAddress2 · String!
The second line of the address.
city
city · String!
The city of the address.
cityArea
cityArea · String!
The district of the address.
postalCode
postalCode · String!
The postal code of the address.
country
country · CountryDisplay!
The country of the address.
countryArea
countryArea · String!
The country area of the address.
phone
phone · String
The phone number assigned the address.
isDefaultShippingAddress
isDefaultShippingAddress · Boolean
Address is user’s default shipping address.
isDefaultBillingAddress
isDefaultBillingAddress · Boolean
Address is user’s default billing address.
Used by
- Checkout (objects)
- Shop (objects)
- _Entity (unions)
- Order (objects)
- Warehouse (objects)
- TaxableObject (objects)
- AccountAddressCreate (objects)
- AccountAddressDelete (objects)
- AccountAddressUpdate (objects)
- AddressCreate (objects)
- AddressCreated (objects)
- AddressDelete (objects)
- AddressDeleted (objects)
- AddressUpdate (objects)
- AddressUpdated (objects)
- User (objects)
- address (queries)
Schema: Saleor 3.23.43. Download SDL.