v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB

Customs Items

Create a new customs item

Creates a new customs item object.

post/customs/items

Headers

SHIPPO-API-VERSIONstring

Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Request body

descriptionstring required

Text description of your item.

eccn_ear99string

Export Control Classification Number, required on some exports from the United States.

mass_unit'g' | 'kg' | 'lb' | 'oz' required

The unit used for weight.

metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

net_weightstring required

Total weight of this item, i.e. quantity * weight per item.

origin_countrystring required

Country of origin of the item. Example: US or DE. All accepted values can be found on the Official ISO Website.

quantityinteger required

Quantity of this item in the shipment you send. Must be greater than 0.

sku_codestring

SKU code of the item, which is required by some carriers.

hs_codestring

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.

tariff_numberstring

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.

value_amountstring required

Total value of this item, i.e. quantity * value per item.

value_currencystring required

Currency used for value_amount. The official ISO 4217 currency codes are used, e.g. USD or EUR.

Example request

{
  "description": "T-Shirt",
  "mass_unit": "lb",
  "metadata": "Order ID \"123454\"",
  "net_weight": "5",
  "quantity": 20,
  "sku_code": "HM-123",
  "hs_code": "0901.21",
  "value_amount": "200",
  "value_currency": "USD"
}

Response

Customs item

descriptionstring required

Text description of your item.

eccn_ear99string

Export Control Classification Number, required on some exports from the United States.

mass_unit'g' | 'kg' | 'lb' | 'oz' required

The unit used for weight.

metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

net_weightstring required

Total weight of this item, i.e. quantity * weight per item.

origin_countrystring required

Country of origin of the item. Example: US or DE. All accepted values can be found on the Official ISO Website.

quantityinteger required

Quantity of this item in the shipment you send. Must be greater than 0.

sku_codestring

SKU code of the item, which is required by some carriers.

hs_codestring

tariff_numberstring

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.

value_amountstring required

Total value of this item, i.e. quantity * value per item.

value_currencystring required

Currency used for value_amount. The official ISO 4217 currency codes are used, e.g. USD or EUR.

object_createdstring date-time

Date and time of object creation.

object_idstring

Unique identifier of the given object.

object_ownerstring

Username of the user who created the object.

object_state'VALID' | 'INVALID'

Indicates the validity of the enclosing object

object_updatedstring date-time

Date and time of last object update.

testboolean

Indicates whether the object has been created in test mode.

Example response

{
  "description": "T-Shirt",
  "mass_unit": "lb",
  "metadata": "Order ID \"123454\"",
  "net_weight": "5",
  "quantity": 20,
  "sku_code": "HM-123",
  "hs_code": "0901.21",
  "value_amount": "200",
  "value_currency": "USD",
  "object_created": "2014-07-17T00:49:20.631Z",
  "object_id": "d799c2679e644279b59fe661ac8fa488",
  "object_owner": "shippotle@shippo.com",
  "object_updated": "2014-07-17T00:49:20.631Z"
}