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

MailingAddressInput input object

Version unstable

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2021-04 (Release candidate)

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2021-01 (Latest)

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2020-10

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2020-07

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2020-04

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2020-01 (Unsupported)

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2019-10 (Unsupported)

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2019-07 (Unsupported)

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.

Version 2019-04 (Unsupported)

The fields used to create or update a mailing address.

Input 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. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

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

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • 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. This argument is deprecated: Use provinceCode instead.

  • provinceCode (String)

    The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

  • zip (String)

    The zip or postal code of the address.