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

Unique custom product identifier

originCountryCode
required
string

ISO country code of product origin

hsTariffCode
string

Harmonized system tariff code

quantity
required
integer

Quantity of items

unitPrice
required
number <float>

Unit price of the product

weightUnit
required
string

Unit of weight

Value: "OZ"
weight
required
number <float>

Net weight 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": "cp00000922010",
  • "originCountryCode": "IN",
  • "hsTariffCode": "hsc01",
  • "quantity": 1,
  • "unitPrice": 100,
  • "weightUnit": "OZ",
  • "weight": 10
}
Response samples
application/json
{
  • "productId": "cp00000922010"
}