| Field | Type | Required | Description | Example |
|---|---|---|---|---|
description |
str | ✔️ | Text description of your item. | T-Shirt |
mass_unit |
components.WeightUnitEnum | ✔️ | The unit used for weight. | lb |
net_weight |
str | ✔️ | Total weight of this item, i.e. quantity * weight per item. | 5 |
origin_country |
str | ✔️ | Country of origin of the item. Example: US or DE. All accepted values can be found on the Official ISO Website. |
|
quantity |
int | ✔️ | Quantity of this item in the shipment you send. Must be greater than 0. | 20 |
value_amount |
str | ✔️ | Total value of this item, i.e. quantity * value per item. | 200 |
value_currency |
str | ✔️ | Currency used for value_amount. The official ISO 4217 currency codes are used, e.g. USD or EUR. |
USD |
eccn_ear99 |
Optional[str] | ➖ | Export Control Classification Number, required on some exports from the United States. | |
metadata |
Optional[str] | ➖ | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
Order ID "123454" |
sku_code |
Optional[str] | ➖ | SKU code of the item, which is required by some carriers. | HM-123 |
hs_code |
Optional[str] | ➖ | HS code of the item, which is required by some carriers. If tariff_number is not provided, hs_code will be used. If both hs_code and tariff_number are provided, tariff_number will be used. 50 character limit. |
0901.21 |
tariff_number |
Optional[str] | ➖ | The tariff number of the item. If tariff_number is not provided, hs_code will be used. If both hs_code and tariff_number are provided, tariff_number will be used. 12 character limit. |
|
object_created |
date | ➖ | Date and time of object creation. | 2014-07-17T00:49:20.631Z |
object_id |
Optional[str] | ➖ | Unique identifier of the given object. | d799c2679e644279b59fe661ac8fa488 |
object_owner |
Optional[str] | ➖ | Username of the user who created the object. | [email protected] |
object_state |
Optional[components.ObjectStateEnum] | ➖ | Indicates the validity of the enclosing object | |
object_updated |
date | ➖ | Date and time of last object update. | 2014-07-17T00:49:20.631Z |
test |
Optional[bool] | ➖ | Indicates whether the object has been created in test mode. |