Configuring Addresses
You can enter addresses for the following entities:
Entity | Field | Description |
---|---|---|
Ship-to | ship_to | The ship_to field is required for requests sent using the Store Transaction. |
Ship-from | ship_from | If you do not specify a value for the ship_from field, the addressed that you specified during sign-up is used. |
Billing | billing | The billing address, if different from the ship-to address. This field is optional. |
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 over 1 year ago