Name | Type | Description | Notes |
---|---|---|---|
addressId | string | Shipper Address Id<br />If supplied all shipper address fields will be ignored and the address from the Address Book will be used. | [optional] |
shipperReference | string | 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] |
shipperReference2 | string | Shipper Reference 2<br />Your second reference for this shipment. This field is used for tracking shipment usually the EBAY VTN number provided to the consumer. <br />Optional | [optional] |
shipperDepartment | string | Shipper Department Code<br />For Royal Mail shipments, this code must be a valid 10-digit OBA department code. | [optional] |
companyName | string | Company Name | [optional] |
contactName | string | Contact Name | [optional] |
addressLine1 | string | Address Line 1<br />Populate with Shipper's address if provided. | [optional] |
addressLine2 | string | Address Line 2 | [optional] |
addressLine3 | string | Address Line 3 | [optional] |
town | string | Town<br />Required if address is populated. | [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.<br />Required if address is populated.<br />Must be GB, IM, GG or JE. | [optional] |
postcode | string | Postcode / Zip<br />Mandatory for all domestic addresses and some international shipments if address is populated. | [optional] |
phoneNumber | string | Contact Phone Number<br />Must be a valid phone number. | [optional] |
emailAddress | string | Contact Email Address<br />Must be a valid email address. | [optional] |
vatNumber | string | VAT Number | [optional] |