Configuring Addresses

Read about how to configure addresses.

You can enter addresses for the following entities:

  • Ship-to
  • Ship-from
  • Buyers

You can use the fields in the Address object to enter the address line-by-line. The following table summarizes some of the important fields in this object.

For a full list of fields, see Address Object Fields.




The address region or state code. Leave blank if not required.


The address city.


The address post code.


The address 2 letter ISO country code.


The address street address lines concatenated with a comma (,).

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"

If you need further help, contact support at

Did this page help you?