Managed and Premium Tariff Code Classification

OverviewAPI
Version v2
Classifications
CreateHSClassificationRequest
GetHSClassification
HSCodeValidationRequest
HSCodeVerificationRequest
WebhookCallback

ClassificationGetResponse

Unify GET response - one classification record identified by the composite id, with the originating item embedded as item. Field projection is driven by the legacy classification record loaded from the underlying store (HSCT / ItemMaster / DW / parking lot, in priority order), not by parsing the ID. Fields beyond id / status are populated when the legacy record carries them. The embedded item reverses the legacy field-name flips (description -> title, summary -> description, itemGroup -> category); the _uncategorized sentinel is silently dropped.

This model is used in the following APIs:

Parameters
idRequired
string

Composite ID; same value the POST response surfaces under items[].classifications[].id.

activityOptional
string

Reverse-mapped from the legacy uppercase activity (HS_FULL -> hsFull, etc.).

Enum: hsFull, hs6, export, coo
classificationTypeOptional
string
Enum: managed, autoPro, autoEssentials
countryOfDestinationOptional
string

Present for hsFull / hs6.

countryOfExportOptional
string

Present for export.

enrichmentsOptional
array
classificationModifiersOptional
ClassificationModifiers
statusRequired
string

Reverse-mapped from the legacy status using the same heuristics as the POST builder.

Enum: pending, classified, rejected, cannotBeClassified
hsCodeOptional
string

Final HS code; present once status == "classified" for hsFull / hs6.

confidenceOptional
string

Suppressed when the resolved customer's confidenceFlag is off.

Enum: high, medium, low, test
confidenceDescriptionOptional
string

Suppressed alongside confidence for customers without the confidence flag.

rationaleOptional
string

Suppressed unless status == "classified" (V1 parity).

itemOptional
Item