Self-Serve Tariff Code Classification
ClassificationResponseProjection
Response payload for a self-serve classification request. Carries the transaction identifier, the current state of the classification (selected item, candidate HS code, pending and resolved interactions), supporting metadata, and any error indicators.
This model is used in the following APIs:
Identifier of the classification transaction. Echo this value as 'txid' (lowercase 'i') in a continue request. Note: this response field is named 'txId' (camelCase) while the corresponding request field is 'txid' (lowercase 'i'); both refer to the same value, the casing difference is retained for backward compatibility.
Response language as an ISO 639-1 code, echoing the language used to build the response.
Product description that was submitted in the originating classification request, echoed back here for reference.
Concept hierarchy paths ("//"-separated) of candidate items inferred from the product description. Useful for understanding how the engine interpreted the input.
Display name of the item currently selected by the engine. Set to "UNKNOWN_ITEM" when no item could be identified.
Selected Item Path: concept hierarchy path ("//"-separated, root-to-leaf) of the selected item.
Definition of the selected item from the underlying ontology. Empty when no definition is available.
Classified HS code (typically 6 or 8 digits; 4-digit headings are zero-padded to 6 digits when the schedule stops at HS6). Empty until enough information has been gathered to reach a classification.
Interactions whose answer was assumed by the engine via exception rules rather than asked of the user.
Interactions whose answer is currently known (resolved), either by a profile rule or because the user has already answered them.
All past interactions in the order they were asked or resolved during this classification session.
The currently pending item-selection interaction, when the engine is asking the caller to confirm which item the product description refers to. Null when no item-selection question is pending.
The currently pending question that the caller is expected to answer in a continue request. Null when the classification has reached a final HS code or has errored out.
HS headings that remain in scope as potential matches given the information gathered so far.
Comma-separated list of GRI rules and HS legal notes that justify the current classification.
Authoritative sources (for example, CROSS rulings) that support the current classification.
Time spent processing the request, in milliseconds.
True when the engine encountered an unhandled or unrecoverable error (HTTP-level status 901). Null when no system error occurred.
True when the engine raised a MixedContentException, indicating the product description requires a mixed-content (VALUED) breakdown that has not been provided (HTTP-level status 905). Null otherwise.
True when the engine raised a MultipleItemException, indicating the product description references more than one distinct item (HTTP-level status 902), like sets and kits. Null otherwise.
True when the engine raised an ItemOutOfScopeException, indicating the selected item falls outside the supported tariff scope (HTTP-level status 900). Null otherwise.
Human-readable detail of the error, populated when one of the *Error flags is set.
HS schedule version used for this classification. Equal to 'schedule'.
Build timestamp of the underlying classification graph used for this response. Returned as a free-form string wrapped in literal single quotes.
HS schedule version used for this classification. Equal to 'dataVersion'.