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