API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

MailingAddress object

Version unstable

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2021-04 (Release candidate)

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2021-01 (Latest)

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2020-10

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2020-07

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2020-04

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2020-01 (Unsupported)

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2019-10 (Unsupported)

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2019-07 (Unsupported)

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Version 2019-04 (Unsupported)

Represents a customer mailing address.

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

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. 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.

  • countryCodeV2 (CountryCode)

    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.

    Argument Description
    withCompany ( Boolean )

    Whether to include the customer's company in the formatted address.
    Default value: true
    withName ( Boolean )

    Whether to include the customer's name in the formatted address.
    Default value: false
  • formattedArea (String)

    A comma-separated list of the values for city, province, and country.

  • id (ID!)

    Globally unique identifier.

  • lastName (String)

    The last name of the customer.

  • latitude (Float)

    The latitude coordinate of the customer address.

  • longitude (Float)

    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.

  • province (String)

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

  • provinceCode (String)

    The two-letter code for the region.

    For example, ON.

  • zip (String)

    The zip or postal code of the address.

Types that return MailingAddress

Implements

Deprecated fields

  • countryCode (String) deprecated

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

    For example, US.

    Deprecation warning

    Use countryCodeV2 instead

Samples