Wuunder API docs
Components

UpdateShipmentRequest

PropertyTypeDescription
shipment
UpdateShipment
Schema that is used to update an existing shipment. 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.
required
currency
string
Currency used for rates and shipments.
nullable
one of:
EUR
delivery_instructions
string
The delivery instructions given to a carrier. This text should be short. It is only implemented for the following carriers: TNT; Transmission; bpost (only certain products); Mondial Relay;
nullable
length 1...200
description
string
Text field that may contain multiple lines and unicode characters.
\A^[\p{L}\p{N}\p{P}\p{Z}\n]+\z
nullable
length 1...2700
external_id
string
External identification number used for shipments that are generated by third-party systems (like bol.com).
\A[[:alnum:]\-_\\/\.]+\z
nullable
length 1...255
height
integer
The height in CMs.
nullable
value 1...
incoterms
string
Incoterms applicable for shipment. Must be DDP (Delivered Duty Paid) or DAP (Delivered At Place).
nullable
one of:
DDP
DAP
length
integer
The length in CMs.
nullable
value 1...
meta
object
This is an additional free format structured field that will give you the possibility to manage your booking process. Maps and lists are supported.
nullable
order_lines
OrderLine
nullable
description
string
The description/name of the item
required
\A^[\p{L}\p{N}\p{P}\p{Z}\n]+\z
nullable
length 1...2700
ean
string
EAN Code of product (European Article Number)
\A[0-9]{8,13}\z
hs_code
string
HS Code of product (Harmonized Commodity Description and Coding System)
\A[0-9]{6,10}\z
meta
object
This is an additional free format structured field that will give you the possibility to manage your booking process. Maps and lists are supported.
origin_country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
quantity
integer
The number of items for a product in an order line.
required
value 1...
sku
string
SKU Code of product
\A[[:alnum:] \-_]+\z
value
integer
The total value in cents.
required
value 1...
weight
integer
The weight or a product or shipment in grams.
required
value 1...
ordered_at
string
Date time in ISO 8601 format (YYYY-MM-DD HH:MM:SS) in UTC
date-time
nullable
parcelshop_drop_off
boolean
Indicates if the shipment will be dropped of by the sender for pickup at a parcelshop.
nullable
parcelshop_id
string
ID of the parcelshop where the package is going to be delivered. String must contain carrier_code:code_of_parcelshop.
\A[A-Z_]+:[A-Z0-9_]+\z
nullable
length 3...64
receiver_address
UpdateAddress
Address schema that is used to update an existing address in a shipment
nullable
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
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.
\A[[:alnum:] .,&!'\-]+\z
nullable
length 1...255
city
string
City of address.
\A[[:alnum:] .,&'\-]+\z
nullable
length 2...30
country_code
string
ISO country code.
\A[A-Z]{2}\z
nullable
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
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
\A[[:alnum:] -]+\z
nullable
length 1...30
given_name
string
\A[[:alnum:] -]+\z
nullable
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
\A[[:alnum:] \-]+\z
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.
\A[[:digit:] \-+()]+\z
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)
\A[A-Z]{2,3}\z
nullable
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
\A[[:alnum:] .,&'\-]+\z
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.
\A[[:alnum:] -]+\z
nullable
length 1...10
reference
string
Custom reference code to identify your shipments or orders
\A[[:alnum:]\-_\\/\.]+\z
nullable
length 1...255
return
boolean
nullable
sender_address
UpdateAddress
Address schema that is used to update an existing address in a shipment
nullable
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
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.
\A[[:alnum:] .,&!'\-]+\z
nullable
length 1...255
city
string
City of address.
\A[[:alnum:] .,&'\-]+\z
nullable
length 2...30
country_code
string
ISO country code.
\A[A-Z]{2}\z
nullable
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
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
\A[[:alnum:] -]+\z
nullable
length 1...30
given_name
string
\A[[:alnum:] -]+\z
nullable
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
\A[[:alnum:] \-]+\z
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.
\A[[:digit:] \-+()]+\z
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)
\A[A-Z]{2,3}\z
nullable
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
\A[[:alnum:] .,&'\-]+\z
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.
\A[[:alnum:] -]+\z
nullable
length 1...10
type
string
Indicates the type of shipment.
nullable
one of:
document
package
pallet
letterbox
value
integer
The total value in cents.
nullable
value 1...
weight
integer
The weight or a product or shipment in grams.
nullable
value 1...
width
integer
The width of a shipment or product in CMs.
nullable
value 1...

Next

UpdateShipment