MailingAddress object

Represents a customer mailing address.

For example, a customer’s default address and an order’s billing address are both mailling addresses.

On this page

Fields

  • address1 ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The first line of the address. Typically the street address or PO Box number.
  • address2 ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The second line of the address. Typically the number of the apartment, suite, or unit.
  • city ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the city, district, village, or town.
  • company ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the customer’s company or organization.
  • country ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The name of the country.
  • countryCodeV2 ([CountryCode](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/countrycode))
    The two-letter code for the country of the address.
    For example, US.
  • firstName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The first name of the customer.
  • formatted ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A formatted version of the address, customized by the provided arguments.
Argument Description
withCompany
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether to include the customer’s company in the formatted address.
Default value: true
withName
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether to include the customer’s name in the formatted address.
Default value: false
  • formattedArea ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A comma-separated list of the values for city, province, and country.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • lastName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The last name of the customer.
  • latitude ([Float](https://shopify.dev/docs/admin-api/graphql/reference/scalar#float-2021-01))
    The latitude coordinate of the customer address.
  • longitude ([Float](https://shopify.dev/docs/admin-api/graphql/reference/scalar#float-2021-01))
    The longitude coordinate of the customer address.
  • name ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The full name of the customer, based on firstName and lastName.
  • phone ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A unique phone number for the customer.
    Formatted using E.164 standard. For example, +16135551111.
  • province ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The region of the address, such as the province, state, or district.
  • provinceCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The two-letter code for the region.
    For example, ON.
  • zip ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The zip or postal code of the address.

Types that return MailingAddress

  • [Customer.addresses](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#addresses-2021-01)
  • [Customer.defaultAddress](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#defaultaddress-2021-01)
  • [DraftOrder.billingAddress](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#billingaddress-2021-01)
  • [DraftOrder.shippingAddress](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#shippingaddress-2021-01)
  • [Order.billingAddress](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#billingaddress-2021-01)
  • [Order.displayAddress](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#displayaddress-2021-01)
  • [Order.shippingAddress](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#shippingaddress-2021-01)
  • [Shop.billingAddress](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shop#billingaddress-2021-01)

Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

  • countryCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) DEPRECATED
    The two-letter code for the country of the address.
    For example, US.
    Deprecation warning
    Use countryCodeV2 instead