Name | Type | Description | Notes |
---|---|---|---|
address_id | str | Shipper Address Id<br />If supplied all shipper address fields will be ignored and the address from the Address Book will be used. | [optional] |
shipper_reference | str | Shipper Reference<br />Your reference for this shipment.<br />This field is used for Returns processing and is usually the shippers order number provided to the consumer. | [optional] |
shipper_department | str | Shipper Department Code<br />For Royal Mail shipments, this code must be a valid 10-digit OBA department code. | [optional] |
company_name | str | Company Name | [optional] |
contact_name | str | Contact Name | [optional] |
address_line1 | str | Address Line 1<br />Populate with Shipper's address if provided. | [optional] |
address_line2 | str | Address Line 2 | [optional] |
address_line3 | str | Address Line 3 | [optional] |
town | str | Town<br />Required if address is populated. | [optional] |
county | str | County / State / Province<br />Whether this is required or not is dependent on the country settings. | [optional] |
country_code | str | Country Code<br />ISO Alpha-2 Country Code per ISO 3166 Standard.<br />Required if address is populated.<br />Must be GB, IM, GG or JE. | [optional] |
postcode | str | Postcode / Zip<br />Mandatory for all domestic addresses and some international shipments if address is populated. | [optional] |
phone_number | str | Contact Phone Number<br />Must be a valid phone number. | [optional] |
email_address | str | Contact Email Address<br />Must be a valid email address. | [optional] |
vat_number | str | VAT Number | [optional] |