Get a shipment
Look up a shipment by its id or reference fields. Scoped to the API key’s organization, brand (for brand-scoped keys), and live/test mode. For organization-scoped keys, references that collide across brands resolve to the most recently created shipment.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”Successful Response
object
Unique shipment identifier
Brand that owns this shipment
Brand slug identifier
Your internal reference number
Whether this shipment was created with a test API key
Per-shipment EU IOSS registration. Null when the brand default was used.
Shipment currency (ISO 4217)
Total duty amount across all items
Total tax amount across all items
Destination-country surcharges imposed in addition to duties and taxes
Total additional fees
Grand total: duties + taxes + additional country charges + additional fees
Current payment status (pending, paid, expired, etc.)
Shipment creation timestamp (UTC)
Line items with duty/tax breakdown
object
Original item description as submitted
Resolved item description after customs classification
HS code as submitted
HS code resolved by Duty Pro for the destination country
Resolved import HS code for the destination country
Resolved export HS code for the origin country
Country of origin (ISO 3166-1 alpha-2)
Declared value per unit
Number of units
Total value for all units
Shipping cost for this line item, regardless of quantity
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
URL for the consignee payment page. Null if no communication has been sent.
Carrier tracking URL for the consignee. Null if neither a shipment override nor a brand/organization template is configured.
Validation Error