Address

A physical address used for shipping

  • Type: object

    A physical address used for shipping

    • country
      Type: string
      required

      ISO 3166 country code for the country the address is located in

    • state
      Type: string
      required

      State or province the address is located in

    • zip
      Type: string
      required

      ZIP or postal code the address is located in

    • city
      Type: string

      City the address is located in

    • company
      Type: string | null

      Name of the organization. Both name and company can be included

    • email
      Type: string | nullFormat: email

      Email to reach the person or organization

    • name
      Type: string | null

      Name of the person. Both name and company can be included

    • phone
      Type: string

      Phone number to reach the person or organization

    • residential
      Type: boolean | null

      Whether or not this address would be considered residential

    • street1
      Type: string

      First line of the address. Note: For U.S. and CA addresses, if street1 exceeds 35 characters, street2 is empty, and the end of street1 contains a recognized unit number format (e.g., “Apt 10”, or “Unit #99833”), the unit number is moved to street2

    • street2
      Type: string

      Second line of the address. Note: May be automatically populated if a unit number is moved from street1 during address verification