Generated by API Evangelist
Written by API Evangelist tooling for Avalara's API. It is a proposal applied on top of the contract, not a document Avalara publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Avalara Automated Tariff Code Classification API
version: 1.0.0
extends: openapi/avalara-classification-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/classify'].post
update:
x-apievangelist-phrasing:
intent: Classify a product into HS and tax codes
effect: read
questions:
- What HS code and tax code should I use for a product shipping to Canada?
- Can I get a classification with a confidence score from a product description?
instructions:
- text: Classify {description} for destination {destinationCountry}.
slots:
description: requestBody.description
destinationCountry: requestBody.destinationCountry
- text: Suggest an HS code for item {itemCode}, {description}, shipping from {originCountry} to {destinationCountry}.
slots:
itemCode: requestBody.itemCode
description: requestBody.description
originCountry: requestBody.originCountry
destinationCountry: requestBody.destinationCountry
method: generated
generated: '2026-09-26'
- target: $.paths['/classify/batch'].post
update:
x-apievangelist-phrasing:
intent: Classify many products in one request
effect: read
questions:
- Can I classify a whole product list at once instead of one by one?
- Is there a bulk option to get HS codes for multiple items in a single call?
instructions:
- text: Classify these products {items} for {destinationCountry} in one batch.
slots:
items: requestBody.items
destinationCountry: requestBody.destinationCountry
- text: Run a batch classification on {items}.
slots:
items: requestBody.items
method: generated
generated: '2026-09-26'
- target: $.paths['/hscodes/{hsCode}'].get
update:
x-apievangelist-phrasing:
intent: Look up an HS code
effect: read
questions:
- What does HS code 6109.10 cover?
- Can I look up an HS code's description for a specific country's tariff schedule?
instructions:
- text: Look up HS code {hsCode}.
slots:
hsCode: path.hsCode
- text: Describe HS code {hsCode} for country {country}.
slots:
hsCode: path.hsCode
country: query.country
method: generated
generated: '2026-09-26'
- target: $.paths['/hscodes/{hsCode}/hierarchy'].get
update:
x-apievangelist-phrasing:
intent: Get the chapter-to-tariff hierarchy of an HS code
effect: read
questions:
- Which chapter and heading does an HS code sit under?
- Can I see the full path from chapter down to national tariff line for a code?
instructions:
- text: Show the hierarchy for HS code {hsCode}.
slots:
hsCode: path.hsCode
- text: Get the chapter, heading and subheading tree of {hsCode} in {country}.
slots:
hsCode: path.hsCode
country: query.country
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.