Components
UpdateOrderReceiver
Schema that is used to update an existing receiver field in an order. All fields are optional and will be used to patch fields. Nills are accepted an will result in updating the field to an empty value.
| Property | Type | Description |
|---|---|---|
| required | ||
address2 | string | Address2 address field. nullable 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. nullable length 1...255 |
city | string | City of address. nullable length 2...30 |
country_code | string | ISO country code. nullable length 2...2 |
email_address | string | Email address compatible with RFC 5322. nullable length 3...320 |
eori_number | string | Economic Operators Registration and Identification number that is required by businesses to ship internationally. nullable length 3...17 |
family_name | string | nullable length 1...30 |
given_name | string | nullable length 1...30 |
house_number | string | House number in an address. May also contain house number extensions. nullable 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. nullable length 1...64 |
phone_number | string | Phone number that may consist of a country code. nullable 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) nullable length 2...3 |
street_name | string | Street name is an identifying name given to a street or road. nullable 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. nullable length 1...10 |