Classify

The Classify resource permits a user to retrieve the most likely HS code and description for one or more products. Each successful request costs $0.05 (USD) regardless of the number of products.

Scope: classify

Actions

POST /classify Get HS codes and descriptions for products

Properties

destination_country

{"destination_country": "US"}

String - The destination country code. Required
origin_country

{"origin_country": "CN"}

String - The origin country code. Required
products 
{
    "products": [
        {
            "hs_code": "610610",
            "description": "Sports Bra"
        }
    ]
}
Array - List of products. Minimum: 1. Maximum: 20. Required
  • hs_code: String(6,)|null - An HS code of the product that is 6 or more digits. Optional
  • description: String - A description of the product. Required
  • result: Object - The result of the request. Read only.
    • import_hs_code: String - The most likely 10-digit HS code of the product for the destination country.
    • export_hs_code: String - The most likely 10-digit HS code of the product for the origin country.
    • description: String - The most likely description of the product.
POST
/classify
Get HS codes and descriptions for up to 20 products.
request
POST /classify 
{
    "classify": {
        "origin_country": "CN",
        "destination_country": "US",
        "products": [
            {
                "description": "Sports Bra"
            },
            {
                "hs_code": "611599",
                "description": "Socks"
            }
        ]
    }
}
response

HTTP/1.1 200 OK

{
    "classify": {
        "origin_country": "CN",
        "destination_country": "US",
        "products": [
            {
                "description": "Sports Bra",
                "result": {
                    "import_hs_code": "6212109020",
                    "export_hs_code": "6212109000",
                    "description": "sports bra"
                }
            },
            {
                "hs_code": "611599",
                "description": "Socks",
                "result": {
                    "import_hs_code": "6115959000",
                    "export_hs_code": "6115950000",
                    "description": "socks"
                }
            }
        ]
    }
}