Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
destination_country
string
required

2-letter destination country code

Required string length: 2
Example:

"US"

codes
object[]
required

List of HS codes with their individual details

Minimum array length: 1
reference
string

Reference identifier for the calculation batch

Example:

"order-123"

destination_country_currency
string

3-letter currency code for destination

Required string length: 3
Example:

"USD"

weight
number

Default weight for items without specific weight (optional, but if provided, weight_unit is required)

Required range: x >= 0
Example:

15

weight_unit
enum<string>

Default weight unit (required if weight is provided)

Available options:
kg,
lb
Example:

"kg"

volume
number

Default volume for items without specific volume (optional, for volume-based specific duties)

Required range: x >= 0
Example:

10

volume_unit
enum<string>

Default volume unit (required if volume is provided)

Available options:
liter,
ml,
hl,
gallon,
proof_liter
Example:

"liter"

quantity
number
default:1

Quantity applied to all codes

Required range: x >= 0
shipping_cost
number

Total shipping cost for all items

Required range: x >= 0
Example:

200

insurance_cost
number

Total insurance cost for all items

Required range: x >= 0
Example:

50

quantity_unit
string

Unit of quantity

Example:

"No."

transport_mode
enum<string>
default:sea

Mode of transport

Available options:
sea,
air,
road,
rail
shipping_terms
enum<string>
default:FOB

Shipping terms

Available options:
FOB,
CIF,
EXW,
DDP
entry_date
string<date>

Entry date for historical calculations

Response

200 - application/json

Successful batch calculation

success
boolean
Example:

true

request_id
string<uuid>
Example:

"c6f398bb-1dad-40e8-a991-a22a180ad842"

reference
string
Example:

"order-123"

calculation_type
string
Example:

"US"

destination_country
string
Example:

"US"

transport_mode
string
Example:

"air"

shipping_terms
string
Example:

"FOB"

quantity
number
Example:

1

values
object
currencies
object
exemptions
object
results
object[]

Array of calculation results for each HS code

Successful calculation result