Name | Type | Description | Notes |
---|---|---|---|
addressId | string | Destination Address ID<br />If supplied all destination address fields will be ignored and the stored address will be used.<br />If a Safeplace is present in the stored address, the Safeplace enhancement will be used if the service allows it, otherwise it will be ignored. ShipmentInformation.ServiceOptions.Safeplace overrides the address Safeplace and forces Safeplace to be required enhancement of the service. | [optional] |
companyName | string | Company Name | [optional] |
contactName | string | Contact Name<br />Required if Address Id is not provided. | [optional] |
addressLine1 | string | Address Line 1<br />Required if Address Id is not provided. | [optional] |
addressLine2 | string | Address Line 2<br />Please ensure the address data is presented in line with the destination country formats. | [optional] |
addressLine3 | string | Address Line 3<br />Please ensure the address data is presented in line with the destination country formats. | [optional] |
town | string | Town<br />Required if Address Id is not provided. | [optional] |
county | string | County / State / Province<br />Whether this is required or not is dependent on the country settings. | [optional] |
countryCode | string | Country Code<br />ISO Alpha-2 Country Code per ISO 3166 Standard. Required if Address Id is not provided | [optional] |
postcode | string | Postcode / Zip<br />Mandatory for all domestic shipments and some international shipments if the Address Id is not provided. | [optional] |
phoneNumber | string | Contact Phone Number<br />Required if SMS notifications are requested (Service Enhancement Code 13 or 16) and Address Id is not provided.<br />Must be a valid phone number. | [optional] |
emailAddress | string | Contact Email Address<br />Required if email notifications are requested (Service Enhancement Code 14 or 16) and Address Id is not provided.<br />Must be a valid email address. | [optional] |
vatNumber | string | VAT Number | [optional] |