CustomerAddress - customer - OBJECT

Version: 2025-01

Description:

Represents a customer's mailing address. For example, a customer's default address and an order's billing address are both mailing addresses. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).

Access Scopes

Fields

  • address1: String - The first line of the address. Typically the street address or PO Box number.
  • address2: String - The second line of the address. This is typically the apartment, suite, or unit number.
  • city: String - The name of the city, district, village, or town.
  • company: String - The name of the customer's company or organization.
  • country: String - The name of the country.
  • firstName: String - The first name of the customer.
  • formatted: String! - A formatted version of the address, customized by the provided arguments.
  • formattedArea: String - A comma-separated list of the values for city, province, and country.
  • id: ID! - A globally-unique ID.
  • lastName: String - The last name of the customer.
  • name: String - The full name of the customer, based on firstName and lastName.
  • phoneNumber: String - The customer's unique phone number. Formatted using E.164 standard. For example, _+16135551111_.
  • province: String - The region of the address, such as the province, state, or district.
  • territoryCode: CountryCode - The two-letter code for the country of the address. For example, US.
  • zip: String - The zip or postal code of the address.
  • zoneCode: String - The alphanumeric code for the region. For example, ON.

Connections

Related queries

Related mutations

  • customerAddressCreate Creates a new address for a customer.
  • customerAddressUpdate Updates a specific address for a customer.

Related Unions

Examples