Name | Type | Description | Notes |
---|---|---|---|
address_id | str | Address ID<br />Your unique identifier for this address.<br />If not provided, a GUID will be generated. | [optional] |
is_return_address | bool | Is Return Address<br />If true, then this address is also available as a return address. | |
company_name | str | Company Name<br />Ignored if is a return address | [optional] |
contact_name | str | Contact Name / Return Name | |
address_line1 | str | Address Line 1 | |
address_line2 | str | Address Line 2 | [optional] |
address_line3 | str | Address Line 3 | [optional] |
town | str | Town | |
county | str | County / State / Province<br />Conditional dependent on country.<br />USA, Australia and Canada all require a valid state code or name. | [optional] |
country_code | str | Country Code<br />ISO Alpha-2 Country Code per ISO 3166 Standard<br />Required to be GB if is a return address | |
postcode | str | Postcode / Zip<br />Required for domestic addresses and some international addresses. | [optional] |
phone_number | str | Contact Phone Number<br />Required for destination addresses where SMS notifications are requested.<br />(Service Enhancement Code 13 or 16)<br />Ignored if is a return address | [optional] |
email_address | str | Contact Email Address<br />Required for destination addresses where email notifications are requested.<br />(Service Enhancement Code 14 or 16)<br />Ignored if is a Return Address | [optional] |
vat_number | str | VAT Number<br />Ignored if is a return address | [optional] |
safeplace | str | Safeplace<br />Free text to describe a safe place to leave the parcel if the service allows it.<br />Ignored if is a return address | [optional] |