Components
Parcelshop
Contains information about parcelshop. A parcelshop is a place where shipments can be send to or send from.
| Property | Type | Description |
|---|---|---|
| required | ||
| required | ||
address2 | string | Address2 address field. length 1...255 |
business_name | string | Name of business for address. If this name is supplied, it will indicate that the address type is business. If left empty, it indicates that the address type is a consumer. length 1...255 |
city | string | City of address. required length 2...30 |
country_code | string | ISO country code. required length 2...2 |
email_address | string | Email address compatible with RFC 5322. length 3...320 |
eori_number | string | Economic Operators Registration and Identification number that is required by businesses to ship internationally. length 3...17 |
family_name | string | Also known as last name. Refers to the name of the contact person to whom the address belongs. length 1...30 |
given_name | string | Also known as first name. Refers to the personal name of the contact person to whom the address belongs. length 1...30 |
house_number | string | House number in an address. May also contain house number extensions. length 1...14 |
id | string | Unique ID for an address. Can be a ID of an existing sender_address or a unique ID of a parcelshop. In all other cases this ID is empty. length 1...64 |
phone_number | string | Phone number that may consist of a country code. length 2...30 |
state_code | string | State code for an address. The state code should be applicable for the country. So NY (New York) for country_code US (United States) or YT (Yukon) for country_code CA (Canada) length 2...3 |
street_name | string | Street name is an identifying name given to a street or road. required length 2...55 |
vat | string | Value-added tax identification number or VAT identification number (VATIN). nullable length 3...14 |
zip_code | string | The zipcode of an address. required length 1...10 |
object | required | |
type | string | one of: consumer business |
object | required | |
carrier_code | string | required |
latitude | number | |
longitude | number | |
opening_hours | object | |
hours | array | |
weekday | string | Day of the week. one of: monday tuesday wednesday thursday friday saturday sunday |
website_url | string | |
wuunder_reference | string | ID of the parcelshop where the package is going to be delivered. String must contain carrier_code:code_of_parcelshop. required length 3...64 |