Add Customs Product

Request

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.

Security

bearerAuth

Bodyapplication/jsonrequired

descriptionstringrequired

Description of the product.

Example:"This is description of the product"

originCountryCodestringrequired

ISO country code of the product origin.

Example:"US"

hsTariffCodestring

Harmonized System (HS) tariff code.

Example:"hsc01"

quantityintegerrequired

Quantity of the product.

Example:1

unitPricenumber, (float)required

Unit price of this item.

Example:10

itemIdstring

Unique identifier for the commodity.

Example:"item1"

urlstring

Product page URL for this item.

Example:"abc"

productDimensionsobjectrequired

Physical details of the product (Item).

weightUnitstring

Unit of weight.

Enum:"OZ""GM"

Example:"OZ"

weightnumber, (float)

Weight of the product(Item).

Example:10

curl -i -X POST \
  https://api-sandbox.sendpro360.pitneybowes.com/shipping/api/v1/customsproduct \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "This is description of the product",
    "originCountryCode": "US",
    "hsTariffCode": "hsc01",
    "quantity": 1,
    "unitPrice": 10,
    "itemId": "item1",
    "url": "abc",
    "productDimensions": {
      "length": 10,
      "height": 10,
      "width": 10,
      "dimUnit": "IN"
    },
    "weightUnit": "OZ",
    "weight": 10
  }'

Responses

Customs Product identifier successfully created.

Bodyapplication/json

customsProductIdstring

The generated customs product identifier that can be used as customs items for international shipments. The items/properties defined here can only be used in the customsItems array.

Example:"cp00000922010"

Response

{
  "customsProductId": "cp00000922010"
}