Tariff Code Classification

Version v2
CreateHSClassificationRequest
GetHSClassification
HSCodeValidationRequest
HSCodeVerificationRequest
WebhookCallback

HSClassificationModel

This model is used in the following APIs:

Parameters
idOptional
string

The id of the HS classification request. This id is created by CreateHSClassificationRequest and returned in the response.

itemRequired
ItemModel
activityOptional
string

The required classification activity for the request. Accepted values are: HS_FULL : full HS code classification (country specific). This is the default activity if no value is specified in the request. HS6: 6 digits HS code classification

countryOfDestinationRequired
hsCodeOptional
string

This is the HS classification result. It’ll be returned in the body for GetHSClassification method.

statusOptional
string

This value is returned by get HS Classification method. It’ll be ignored if it’s provided in the request.

Enum: PENDING, CLASSIFIED, CANNOT_BE_CLASSIFIED
resolutionOptional
string

This value will be returned by getHSClassification method only if an item cannot be classified (status=CANNOT_BE_CLASSIFIED). It contains a detailed description of the issue. It’ll be ignored if it’s provided in the request.

confidenceOptional
string

If the information provided in the request is not enough, an accurately classification might not be possible. In this case, the assumption made for classification will be returned in this field.

confidenceDescriptionOptional
string

This is a detailed description of the assumptions made in order to classify an item when information provided in the request is not enough (e.g. similar product URL, product number or anything which can be used as identifier behind the classification logic).

possibleHsCodesOptional
string

Alternative HS codes that could apply to this item, when available. This field is only included when the broker parameter is set to "true" and there are alternative HS codes available. Provided as a stringified JSON array.

productUpdateOptional
boolean

Indicates whether the product information was updated during classification.

validCODsOptional
array

List of valid country codes that were successfully processed

invalidCODsOptional
array

List of invalid country codes that could not be processed