ShopifyMailingAddress

Type

import { ShopifyMailingAddress } from '@daffodil/driver/shopify'

A physical mailing address associated with a Customer or Order. Stores standard address components including street address, city, province, country, and postal code, along with customer name and company information.

The address includes geographic coordinates and provides pre-formatted output through the formatted field, which can optionally include or exclude name and company details.

interface ShopifyMailingAddress {
  __typename: "MailingAddress"
  address1: string
  address2: string
  city: string
  company: string
  country: string
  countryCode: string
  countryCodeV2: ShopifyCountryCode
  firstName: string
  formatted: string[]
  formattedArea: string
  id: string
  lastName: string
  latitude: number
  longitude: number
  name: string
  phone: string
  province: string
  provinceCode: string
  zip: string
}

Properties

__typename `"MailingAddress"`

address1 `string`
The first line of the address. Typically the street address or PO Box number.

address2 `string`
The second line of the address. Typically the number of the apartment, suite, or unit.

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.

countryCode `string`
The two-letter code for the country of the address. For example, US.

countryCode

string

The two-letter code for the country of the address.

For example, US.

countryCodeV2 `ShopifyCountryCode`
The two-letter code for the country of the address. For example, US.

countryCodeV2

ShopifyCountryCode

The two-letter code for the country of the address.

For example, US.

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 `string`
A globally-unique ID.

lastName `string`
The last name of the customer.

latitude `number`
The latitude coordinate of the customer address.

longitude `number`
The longitude coordinate of the customer address.

name `string`
The full name of the customer, based on firstName and lastName.

phone `string`
A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

phone

string

A unique phone number for the customer.

Formatted using E.164 standard. For example, +16135551111.

province `string`
The region of the address, such as the province, state, or district.

provinceCode `string`
The alphanumeric code for the region. For example, ON.

provinceCode

string

The alphanumeric code for the region.

For example, ON.

zip `string`
The zip or postal code of the address.