Create order
Ongoing improvements
We are actively working on improving this documentation. The contents of this page may be incomplete and are subject to change.
Orders and shipments are the basis of shipping out your shipments (packages).
Order
An order is a collection of shipments. It holds mainly metadata about the shipments you are about to send out. This data is useful to identify the shipments that belong to each other.
An order, consists of the following properties:
| Property | Type | Description |
|---|---|---|
| required | ||
reference | string | Custom reference code to identify your shipments or orders required length 1...255 |
object | required | |
id | string | Unique identifier for order. required uuid |
inserted_at | string | Date time in ISO 8601 format (YYYY-MM-DD HH:MM:SS) in UTC required date-time |
order_code | string | Unique human readable identifier of an order in Wuunder. length 13...13 |
receiver | Specifies the full legal address of a business or person, including street, house number, zip code, city, and country that is used to send the order to. required | |
sender | Specifies the full legal address of a business or person, including street, house number, zip code, city, and country that is used to send the order from. required | |
shipments | ||
status | string | required |
status_history | object | Contains all historical events that took place on this shipment or order. required |
updated_at | string | Date time in ISO 8601 format (YYYY-MM-DD HH:MM:SS) in UTC required date-time |
The receiver and sender can contain address data that isn't neccesarily the origin or destination address of the
individual shipments (see this example)
Shipment
A shipment is the package that will be send out to your customers. It holds all the necessary data required for carriers to ship out your shipments.
All shipments belong to an order.