CustomsItem

A CustomsItem object describes goods for international shipment and should be created then included in a CustomInfo object.

Endpoints

POST

/customs_items

GET

/customs_items/:id

CustomsItems object

string

Unique, begins with 'cstitem_'

object

string

'CustomsItem'

description

string

Description of item being shipped

quantity

float

Must be greater than zero

value

float (USD)

Total value (unit value * quantity). Must be greater than zero.

weight

float (oz)

Total weight (unit weight * quantity). Must be greater than zero.

hs_tariff_number

string

Harmonized Tariff Schedule, e.g. "6109.10.0012" for men's T-shirts

code

string

SKU, UPC or other product identifier

origin_country

string

Two-character country code

currency

string

"Three-character currency code. Defaults to "USD"

created_at

datetime

When the CustomsItem was created

updated_at

datetime

When the CustomsItem was last updated

CustomsItems Object

{
  "id": "cstitem_71233110339145c8b1cd9107b9fff1af",
  "object": "CustomsItem",
  "created_at": "2024-01-24T00:05:43Z",
  "updated_at": "2024-01-24T00:05:43Z",
  "description": "T-shirt",
  "hs_tariff_number": "123456",
  "origin_country": "US",
  "quantity": 1,
  "value": "10.0",
  "weight": 5,
  "code": "123",
  "mode": "test",
  "manufacturer": null,
  "currency": null,
  "eccn": null,
  "printed_commodity_identifier": null
}

Create a CustomsItem

A CustomsItem contains information relating to each product within the package. When creating a CustomsItem, you may store the id from the response for use later in CustomsInfo creation.

A CustomsItem object is immutable once created. All information must be provided during creation; it cannot be modified later.

Request Parameters

description

i.e. "T-Shirt"

quantity

i.e. 1

weight

i.e. 5

value

i.e. 10

hs_tariff_number

i.e. "123456"

origin_country

i.e. "US"

POST /customs_items

1curl -X POST https://api.easypost.com/v2/customs_items \
2  -u "EASYPOST_API_KEY": \
3  -H 'Content-Type: application/json' \
4  -d '{
5    "customs_item": {
6      "description": "T-shirt",
7      "quantity": "1",
8      "weight": "5",
9      "value": "10",
10      "hs_tariff_number": "123456",
11      "origin_country": "US"
12    }
13  }'

Response

1{
2  "id": "cstitem_71233110339145c8b1cd9107b9fff1af",
3  "object": "CustomsItem",
4  "created_at": "2024-01-24T00:05:43Z",
5  "updated_at": "2024-01-24T00:05:43Z",
6  "description": "T-shirt",
7  "hs_tariff_number": "123456",
8  "origin_country": "US",
9  "quantity": 1,
10  "value": "10.0",
11  "weight": 5.0,
12  "code": "123",
13  "mode": "test",
14  "manufacturer": null,
15  "currency": null,
16  "eccn": null,
17  "printed_commodity_identifier": null
18}

Retrieve a CustomsItem

A CustomsItem can be retrieved by its id.

GET /customs_items/:id

1curl -X GET https://api.easypost.com/v2/customs_items/cstitem_... \
2  -u "EASYPOST_API_KEY":

Response

1{
2  "id": "cstitem_35d99d275eb346dcb77fbd42b90cb76c",
3  "object": "CustomsItem",
4  "created_at": "2024-01-24T00:05:44Z",
5  "updated_at": "2024-01-24T00:05:44Z",
6  "description": "T-shirt",
7  "hs_tariff_number": "123456",
8  "origin_country": "US",
9  "quantity": 1,
10  "value": "10.0",
11  "weight": 5.0,
12  "code": "123",
13  "mode": "test",
14  "manufacturer": null,
15  "currency": null,
16  "eccn": null,
17  "printed_commodity_identifier": null
18}