Addresses
You may want to model addresses for shipping or payments or billing.
You can model addresses for the following entities:
- Ship-to
- Ship-from
- Payment Address
- Billing Address
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.
Field | Description |
---|---|
country_subdivision_code | The address region or state code. Leave blank if not required. |
city | The address city. |
postal_code | The address post code. |
country_code | The address 2 letter ISO country code. |
street_name | 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"
},
Updated 20 days ago