Addresses
Use addresses to model physical locations, such as a shipping address.
You can model addresses for the following entities:
| Entity | Field | Description |
|---|---|---|
| Shipping | ship_to_address | The buyer's shipping address. |
| Shipping | ship_from_address | The marketplace or seller's shipping address. |
| Billing | billing_address | The billing address, if different from the ship_to_address. This field is required when using Vertex Validator to validate provinces or other country subdivisions. |
| Payment | payment | The payment address, if different from the ship_to_address address. This field is not used for location or tax determination. |
Address modeling
You can use the Address Object Fields to enter address information. For more information, see the Seller Address Object Fields and Marketplace Address Object Fields.
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 address location is based on the specified country_code field. To specify a country subdivision, use the country_subdivision_code field. The service validates subdivisions for countries that support them.
The service does not validate other address information.
Updated 15 days ago
Did this page help you?
