Components

Container

Specifies a container where items will be shipped in. A container with items can be converted into a Shipment.

PropertyTypeDescription
required
height
integer
The height in CMs.
required
value 1...
length
integer
The length in CMs.
required
value 1...
width
integer
The width of a shipment or product in CMs.
required
value 1...
object
required
kind
string
The type of container that is used to put the items in
required
one of:
document
package
pallet
letterbox
packing_instructions
required
item
A specification of a product that can be packed into a container.
required
required
height
integer
The height in CMs.
required
value 1...
length
integer
The length in CMs.
required
value 1...
width
integer
The width of a shipment or product in CMs.
required
value 1...
object
required
description
string
A human readable description of the item
ean
string
EAN Code of product (European Article Number)
\A[0-9]{8,13}\z
external_id
string
Identifier unique to the item
hs_code
string
HS Code of product (Harmonized Commodity Description and Coding System)
\A[0-9]{6,10}\z
reference
string
Custom reference code to identify your shipments or orders
\A[[:alnum:]\-_\\/\.]+\z
length 1...255
sku
string
SKU Code of product
\A[[:alnum:] \-_]+\z
value_in_cents
integer
The total value in cents.
required
value 1...
weight
integer
The weight or a product or shipment in grams.
required
value 1...
step
integer
The step of when to pack this item
reference
string
required
value_in_cents
integer
The total value in cents.
required
value 1...
weight
integer
The weigth of the box in grams
required
value 1...