Addresses

Use addresses to model physical location information, such as a Ship To address.

You can enter addresses for the following entities:

EntityFieldDescription
Ship Toship_to_addressFor physical goods, the ship_to_address field is required for the Store Transaction and Calculate Tax requests.
Ship Fromship_from_addressThe ship_from_address field is required for physical goods.
Billingbilling_addressThe billing address, if different from the ship_to_address. This field is required if you are using Vertex Validator to validate provinces or other country subdivisions.
PaymentpaymentThe payment address, if different from the ship_to_address address. This field is NOT used in location or tax determination.

Address modeling

You can use the fields in the Address object to enter the address line-by-line. The full list of fields is also documented in the Address Object Fields topic.

FieldDetailsDescription
country_subdivision_code

Type: String

Max: 6

The state or province code that represents the subdivision. You must use the full ISO code (here). For example, you would use US-CA to represent California. Leave this field blank if it is not required.
city

Type: String

Max: 256

City.
postal_code

Type: String

Max: 256

Post code.
county

Type: String

Max: 256

County.
country_code

Min: 2

Max: 2

Pattern: ^[A-Z]{2}$

The address's 2 letter ISO country code. If an address is later used for tax or liability determination (like for physical goods), it will use this value to as the geographic location of the address, unless a subdivision exists.
street_name

Type: String

Max: 256

The street name. You can concatenate multiple lines with a comma (,).
address_detail

Type: String

Max: 512

Further address details like apartment number.
freeform_address

Type: String

Max: 256

Specify a free text address.
building_number

Type: String

Max: 256

The number of the building.

Here is an example of how you might model an address in a request:

"ship_to_address": {
      "street_name": "Sunny Street 18",
      "address_detail": "City West",
      "city": "Lisbon",
      "postal_code": "PT1 2345",
      "country_code": "PT"
    },

Alternatively, you can use the freeform_address field to add it as a free text string. For example:

"ship_to_address": {
      "freeform_address": "Sunny Street 18","City West","Lisbon","PT1 2345",
      "country_code": "PT"
    },

Address validation

The addresses location is based on the specified country_code field. For country subdivisions, you use the country_subdivision_code field to specify the subdivision and this is validated for countries that support subdivisions.

Other address details are not validated.