Skip to content

Quote shipment fees

POST
/api/shipments/quote

Calculate landed cost (duties, taxes, additional country charges, and additional fees) for a hypothetical shipment without persisting any data. Use at checkout to show the consignee the total before they pay. Identical fee logic to POST /api/shipments/.

object
brand_id
Brand Id

Brand ID or slug. Required when using an organization-level API key; optional when the key is brand-scoped.

string | null
currency
required
Currency

ISO 4217 currency code for the quote

string
items
required
Items

List of items to quote. At least one item is required.

Array<object>
object
description
required
Description

Product description for customs classification. Used together with the HS code to validate and refine the item’s classification for the destination country.

string
<= 500 characters
declared_value
required
Declared Value

Declared value of a single unit in the shipment currency

number | string
country_of_origin
required
Country Of Origin

ISO 3166-1 alpha-2 country code where the item was manufactured

string
quantity
Quantity

Number of units of this item

integer
default: 1 >= 1
hs_code
required
Hs Code

6-10 digit Harmonized System code. Used together with the description for tariff calculation.

string
<= 20 characters
total_value
Total Value

Total value for all units. If omitted, calculated as declared_value * quantity.

number | string | null
shipping_cost
Shipping Cost

Shipping cost for this line item, regardless of quantity. Added to the duty/tax base by the customs engine. Internal — not shown to the consignee.

number | string | null
ioss_registered
Ioss Registered

EU IOSS registration for VAT (EU destinations only). When true, import VAT is not charged at the border. Omit to use the brand’s default setting.

boolean | null
sender
required

Sender origin, used to determine the export country for the quote.

object
country
required
Country

ISO 3166-1 alpha-2 origin country code

string
consignee
required

Consignee destination, used to determine the import country for the quote.

object
country
required
Country

ISO 3166-1 alpha-2 destination country code

string

Successful Response

object
currency
required
Currency

Quote currency (ISO 4217)

string
total_duties
required
Total Duties

Total duty amount across all items

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_taxes
required
Total Taxes

Total tax amount across all items

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_additional_country_charges
required
Total Additional Country Charges

Destination-country surcharges imposed in addition to duties and taxes

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_additional_fees
required
Total Additional Fees

Total of all additional fees configured for the brand. Includes pre-customs fees that inflate the duty base; their per-item effect is reflected in the items’ declared values used for the calculation.

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
total_amount
required
Total Amount

Grand total: duties + taxes + additional country charges + additional fees

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
items
required
Items

Line items with duty/tax breakdown

Array<object>
object
description
required
Description

Original item description as submitted

string | null
description_resolved
required
Description Resolved

Resolved item description after customs classification

string | null
hs_code
required
Hs Code

HS code as submitted

string | null
hs_code_resolved
required
Hs Code Resolved

HS code resolved by Duty Pro for the destination country

string | null
hs_code_resolved_import
required
Hs Code Resolved Import

Resolved import HS code for the destination country

string | null
hs_code_resolved_export
required
Hs Code Resolved Export

Resolved export HS code for the origin country

string | null
country_of_origin
required
Country Of Origin

Country of origin (ISO 3166-1 alpha-2)

string
declared_value
required
Declared Value

Declared value per unit

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
quantity
required
Quantity

Number of units

integer
total_value
required
Total Value

Total value for all units

string | null
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
shipping_cost
required
Shipping Cost

Shipping cost for this line item, regardless of quantity

string | null
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
duty_amount
required
Duty Amount

Calculated duty amount for this item

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
tax_amount
required
Tax Amount

Calculated tax amount for this item

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
fees
required
Fees

Additional fees applied to the quote. Pre-customs fees are included so the merchant can see why the duty base may differ from the submitted declared values.

Array<object>
object
fee_type
required
Fee Type

Fee type identifier

string
display_name
required
Display Name

Human-readable fee name shown to the consignee

string
amount
required
Amount

Fee amount in the shipment currency

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
original_amount
required
Original Amount

Fee amount in its original currency before conversion

string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
original_currency
required
Original Currency

Original currency of the fee before conversion

string

Validation Error

object
detail
Detail
Array<object>
object
loc
required
Location
Array<string | integer>
msg
required
Message
string
type
required
Error Type
string