Items

Information about the contents of the shipment. Items can be included even if no customs information is required.

Attributes

Attribute	Type	Required	Description
description	string	✓	Description of the item or it’s content.
quantity	integer	✓	Amount of these items present in the shipment.
image_url	string		A link to an image of the item.
item_value	price	For international shipments	Value of a single item. Should be multiplied by quantity to get total value.
item_weight	integer		Weight of a single item. Should be multiplied by quantity to get total weight.
item_weight_unit	string enum: mg g kg oz lb		Unit of measurement for item_weight. If not supplied, g (grams) will be assumed.
hs_code	string		Harmonized System code used by customs.
origin_country_code	string	For international shipments	The country code in ISO 3166-1 alpha-2 format.
is_preferential_origin	boolean		Whether the item is from a preferential origin country (more info).
sku	string		Unique identifier, often the Stock Keeping Unit.

Note on item weight

Since a single item can weigh less than 1 gram, we introduced the ability to specify item weights in milligrams. To not disturb existing flows and avoid decimal values, this is done via the new item_weight_unit attribute. This attribute defaults to grams, but you can use it to supply item weights in milligrams or one of the other supported units. While our API allows item weights as precise as 1 milligram, some carriers force us to round up to the smallest supported unit in their API. This is the reason why the system of a carrier can show a slightly different weight.