Create a shipment
Submit a cross-border shipment for duty and fee calculation. Returns the full fee breakdown, resolved HS codes, and a payment link for the consignee.
Request Body required
Section titled “Request Body required ”object
ISO 4217 currency code for the shipment
List of items in the shipment. At least one item is required.
object
Product description for customs classification
ISO 4217 currency code for the item value
ISO 3166-1 alpha-2 country code where the item was manufactured
Number of units of this item
Full name of the consignee (recipient)
Consignee city
Consignee postal / ZIP code
ISO 3166-1 alpha-2 destination country code
Full name of the sender
Sender city
Sender postal / ZIP code
ISO 3166-1 alpha-2 origin country code
Responses
Section titled “ Responses ”Successful Response
object
Unique shipment identifier
Brand that owns this shipment
Whether this shipment was created with a test API key
Shipment currency (ISO 4217)
Total duty amount across all items
Total tax amount across all items
Total additional fees
Grand total: duties + taxes + additional fees
Current payment status (pending, paid, expired, etc.)
Shipment creation timestamp (UTC)
Line items with duty/tax breakdown
object
Country of origin (ISO 3166-1 alpha-2)
Declared value per unit
Currency code for the item value
Number of units
Calculated duty amount for this item
Calculated tax amount for this item
Additional fees applied to the shipment
object
Fee type identifier
Human-readable fee name shown to the consignee
Fee amount in the shipment currency
Fee amount in its original currency before conversion
Original currency of the fee before conversion
Whether this fee is shown to the consignee on the payment page
Validation Error