Add Customs Product

This operation creates a customs product and returns its identifier. Use this identifier in shipment APIs to prefill customs item fields (HS tariff code, origin country, unit price, weight, quantity).

Note: Support for this capability in the Rate Shipment and Create Shipment APIs is under active development. It is targeted for upcoming release.

SecuritybearerAuth
Request
Request Body schema: application/json
description
required
string

Description of the product.

originCountryCode
required
string

ISO country code of the product origin.

hsTariffCode
string

Harmonized System (HS) tariff code.

quantity
required
integer

Quantity of the product.

unitPrice
required
number <float>

Unit price of this item.

itemId
string

Unique identifier for the commodity.

url
string

Product page URL for this item.

required
object

Physical details of the product (Item).

weightUnit
string

Unit of weight.

Enum: "OZ" "GM"
weight
number <float>

Weight of the product(Item).

Responses
201

Customs Product identifier successfully created.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/customsproduct
Request samples
application/json
{
  • "description": "This is description of the product",
  • "originCountryCode": "US",
  • "hsTariffCode": "hsc01",
  • "quantity": 1,
  • "unitPrice": 10,
  • "itemId": "item1",
  • "url": "abc",
  • "productDimensions": {
    },
  • "weightUnit": "OZ",
  • "weight": 10
}
Response samples
application/json
{
  • "customsProductId": "cp00000922010"
}