--- title: CustomerAddress - Customer API 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). api_version: 2025-07 api_name: customer type: object api_type: graphql source_url: html: 'https://shopify.dev/docs/api/customer/2025-07/objects/CustomerAddress' md: 'https://shopify.dev/docs/api/customer/2025-07/objects/CustomerAddress.md' --- # Customer​Address object 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). ## Fields * address1 [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The first line of the address. Typically the street address or PO Box number. * address2 [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The second line of the address. This is typically the apartment, suite, or unit number. * city [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The name of the city, district, village, or town. * company [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The name of the customer's company or organization. * country [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The name of the country. * first​Name [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The first name of the customer. * formatted [\[String!\]!](https://shopify.dev/docs/api/customer/2025-07/scalars/String) non-null[Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) A formatted version of the address, customized by the provided arguments. * with​Name [Boolean](https://shopify.dev/docs/api/customer/2025-07/scalars/Boolean) Default:false ### Arguments Determines whether to include the customer's name in the formatted address. * with​Company [Boolean](https://shopify.dev/docs/api/customer/2025-07/scalars/Boolean) Default:true Determines whether to include the customer's company in the formatted address. *** * formatted​Area [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) A comma-separated list of the values for city, province, and country. * id [ID!](https://shopify.dev/docs/api/customer/2025-07/scalars/ID) non-null[Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) A globally-unique ID. * last​Name [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The last name of the customer. * name [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The full name of the customer, based on firstName and lastName. * phone​Number [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The customer's unique phone number. Formatted using E.164 standard. For example, *+16135551111*. * province [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The region of the address, such as the province, state, or district. * territory​Code [Country​Code](https://shopify.dev/docs/api/customer/2025-07/enums/CountryCode) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The two-letter code for the country of the address. For example, US. * zip [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The zip or postal code of the address. * zone​Code [String](https://shopify.dev/docs/api/customer/2025-07/scalars/String) [Pre-auth accessible](https://shopify.dev/docs/apps/build/customer-accounts/order-status-page#customer-account-api) The alphanumeric code for the region. For example, ON. *** ## Map ### Fields and connections with this object * [Customer.addresses](https://shopify.dev/docs/api/customer/2025-07/objects/Customer#field-Customer.fields.addresses) * [Customer.defaultAddress](https://shopify.dev/docs/api/customer/2025-07/objects/Customer#field-Customer.fields.defaultAddress) * [CustomerAddressConnection.nodes](https://shopify.dev/docs/api/customer/2025-07/connections/CustomerAddressConnection#returns-nodes) * [CustomerAddressEdge.node](https://shopify.dev/docs/api/customer/2025-07/objects/CustomerAddressEdge#field-CustomerAddressEdge.fields.node) * [DraftOrder.billingAddress](https://shopify.dev/docs/api/customer/2025-07/objects/DraftOrder#field-DraftOrder.fields.billingAddress) * [DraftOrder.shippingAddress](https://shopify.dev/docs/api/customer/2025-07/objects/DraftOrder#field-DraftOrder.fields.shippingAddress) * [Order.billingAddress](https://shopify.dev/docs/api/customer/2025-07/objects/Order#field-Order.fields.billingAddress) * [Order.shippingAddress](https://shopify.dev/docs/api/customer/2025-07/objects/Order#field-Order.fields.shippingAddress) *** ## Mutations * [customer​Address​Create](https://shopify.dev/docs/api/customer/2025-07/mutations/customerAddressCreate) mutation Creates a new address for a customer. * address [Customer​Address​Input!](https://shopify.dev/docs/api/customer/2025-07/input-objects/CustomerAddressInput) required ### Arguments Specifies the fields to use when creating the address. * default​Address [Boolean](https://shopify.dev/docs/api/customer/2025-07/scalars/Boolean) Default:false The flag to set the address as the default address. *** * [customer​Address​Update](https://shopify.dev/docs/api/customer/2025-07/mutations/customerAddressUpdate) mutation Updates a specific address for a customer. * address​Id [ID!](https://shopify.dev/docs/api/customer/2025-07/scalars/ID) required ### Arguments The ID of the address to be updated. * address [Customer​Address​Input](https://shopify.dev/docs/api/customer/2025-07/input-objects/CustomerAddressInput) Specifies the fields to use when updating the address. * default​Address [Boolean](https://shopify.dev/docs/api/customer/2025-07/scalars/Boolean) Default:null The flag to set the address as the default address. *** *** ## CustomerAddress Mutations ### Mutated by * [customer​Address​Create](https://shopify.dev/docs/api/customer/2025-07/mutations/customerAddressCreate) * [customer​Address​Update](https://shopify.dev/docs/api/customer/2025-07/mutations/customerAddressUpdate) *** ## Interfaces * [Node](https://shopify.dev/docs/api/customer/2025-07/interfaces/Node) interface *** ## CustomerAddress Implements ### Implements * [Node](https://shopify.dev/docs/api/customer/2025-07/interfaces/Node)