Self-Serve Tariff Code Classification
Avalara Cross Border Classification Models
| Model | Summary |
|---|---|
Standard error response payload returned by the API when a request fails. Provides a short error title, the HTTP status code, and a human-readable detail message. | |
Request body used to continue an in-progress self-serve tariff classification by answering the questions returned in a prior response. The 'state' field acts as the discriminator and must be 'CONTINUE'. All fields are required. | |
| — | |
An option/attribute returned for a classification interaction. Each attribute represents a candidate answer (e.g. a material, condition, or ingredient) the caller may select when continuing the classification. | |
A classification interaction returned in a classification response. Interactions group together a question prompt, the available options (attrs), and metadata about how the question was answered or inferred. | |
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. | |
Request body used to start a new self-serve tariff classification. The 'state' field acts as the discriminator and must be 'START'. 'proddesc' is required; 'destination', 'origin', and 'lang' are optional. | |
A destination country supported by the customer's profile, including the country code, display name, and the Harmonized System (HS) version that applies for that destination. | |
Customer profile information, including the AvaTax account identifier, the customer name, the list of subscribed services, the supported and subscribed destination countries, and the customer's destination subscription limit. |