ShipmentProperties

Composable schema used for shipments.

Property	Type	Description
`currency`	string	Currency used for rates and shipments. 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` length 1...255
`height`	integer	The height in CMs. value 1...
`incoterms`	string	Incoterms applicable for shipment. Must be DDP (Delivered Duty Paid) or DAP (Delivered At Place). one of: DDP DAP
`length`	integer	The length in CMs. 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.
`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 `\A[[:alnum:]\-_\\/\.]+\z` length 1...255
`return`	boolean
`type`	string	Indicates the type of shipment. one of: document package pallet letterbox
`value`	integer	The total value in cents. 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. value 1...
`width`	integer	The width of a shipment or product in CMs. value 1...