Wuunder API docs
Components

CreateOrderRequest

PropertyTypeDescription
order
CreateOrder
Schema used to create new orders.
required
OrderProperties
required
reference
string
Custom reference code to identify your shipments or orders
required
\A[[:alnum:]\-_\\/\.]+\z
length 1...255
object
required
receiver
CreateOrderReceiver
Schema used to specify a receiver to a newly created oreder.
required
CreateAddress
required
AddressProperties
required
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
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
length 1...255
city
string
City of address.
required
\A[[:alnum:] .,&'\-]+\z
length 2...30
country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
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.
\A[[:alnum:] -]+\z
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.
\A[[:alnum:] -]+\z
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
required
\A[[:alnum:] \-]+\z
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.
\A[[:digit:] \-+()]+\z
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
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
required
\A[[:alnum:] .,&'\-]+\z
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
\A[[:alnum:] -]+\z
length 1...10
sender
CreateOrderSender
Schema used to specify a sender for a newly created oreder.
required
CreateAddress
required
AddressProperties
required
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
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
length 1...255
city
string
City of address.
required
\A[[:alnum:] .,&'\-]+\z
length 2...30
country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
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.
\A[[:alnum:] -]+\z
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.
\A[[:alnum:] -]+\z
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
required
\A[[:alnum:] \-]+\z
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.
\A[[:digit:] \-+()]+\z
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
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
required
\A[[:alnum:] .,&'\-]+\z
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
\A[[:alnum:] -]+\z
length 1...10
shipments
CreateShipment
Optional list of shipments to create with order.
1..30 items
ShipmentProperties
required
currency
string
Currency used for rates and shipments.
required
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.
required
\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
length 1...255
height
integer
The height in CMs.
required
value 1...
incoterms
string
Incoterms applicable for shipment. Must be DDP (Delivered Duty Paid) or DAP (Delivered At Place).
required
one of:
DDP
DAP
length
integer
The length in CMs.
required
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.
ordered_at
string
Date time in ISO 8601 format (YYYY-MM-DD HH:MM:SS) in UTC
date-time
parcelshop_drop_off
boolean
Indicates if the shipment will be dropped of by the sender for pickup at a parcelshop.
required
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
length 3...64
reference
string
Custom reference code to identify your shipments or orders
required
\A[[:alnum:]\-_\\/\.]+\z
length 1...255
return
boolean
required
type
string
Indicates the type of shipment.
required
one of:
document
package
pallet
letterbox
value
integer
The total value in cents.
required
value 1...
webhook_url
string
A valid publicly accessible URL (http or https).
length 1...255
weight
integer
The weight or a product or shipment in grams.
required
value 1...
width
integer
The width of a shipment or product in CMs.
required
value 1...
object
required
order_lines
OrderLine
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...
receiver_address
CreateAddress
Schema used to specify an address for a newly created shipment.
required
AddressProperties
required
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
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
length 1...255
city
string
City of address.
required
\A[[:alnum:] .,&'\-]+\z
length 2...30
country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
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.
\A[[:alnum:] -]+\z
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.
\A[[:alnum:] -]+\z
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
required
\A[[:alnum:] \-]+\z
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.
\A[[:digit:] \-+()]+\z
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
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
required
\A[[:alnum:] .,&'\-]+\z
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
\A[[:alnum:] -]+\z
length 1...10
sender_address
CreateAddress
Schema used to specify an address for a newly created shipment.
required
AddressProperties
required
address2
string
Address2 address field.
\A[[:alnum:] .,&'\-]+\z
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
length 1...255
city
string
City of address.
required
\A[[:alnum:] .,&'\-]+\z
length 2...30
country_code
string
ISO country code.
required
\A[A-Z]{2}\z
length 2...2
email_address
string
Email address compatible with RFC 5322.
\A[\w+\-\.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z
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.
\A[[:alnum:] -]+\z
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.
\A[[:alnum:] -]+\z
length 1...30
house_number
string
House number in an address. May also contain house number extensions.
required
\A[[:alnum:] \-]+\z
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.
\A[[:digit:] \-+()]+\z
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
length 2...3
street_name
string
Street name is an identifying name given to a street or road.
required
\A[[:alnum:] .,&'\-]+\z
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
\A[[:alnum:] -]+\z
length 1...10

Next

CreateOrderReceiver

Next

CreateOrderResponse