Add Custom 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 the product.

itemId
string

Unique identifier(sku) of the item.

url
string

Product page URL.

required
object

Physical details of the product.

Responses
201

Custom Product 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": "towel",
  • "originCountryCode": "US",
  • "hsTariffCode": "hsc01",
  • "quantity": 1,
  • "unitPrice": 10,
  • "itemId": "item1",
  • "url": "abc",
  • "productDetails": {
    }
}
Response samples
application/json
{
  • "productId": "cp00000922010"
}