POST /v1/data/customs/shipments/run
Pricing: $0.03 per customs shipment record ($32.00 per 1,000).
Request
Send the inputs underparams. Only the keys below are accepted; any other key returns 422 invalid_params.
Whether to search import or export customs records.Allowed values:
imports (Imports), exports (Exports).Search only these countries’ customs datasets (for example america, mexico, india); leave empty to search all of them. Some countries have several datasets, e.g. the US has america, america_ship and america_stat.165 allowed values, for example
afghanistan (Afghanistan), africa_bol (Africa BOL), america (America BOL), america_ship (America Master BOL), america_stat (America STAT), angola (Angola), angola_stat (Angola STAT), argentina (Argentina), argentina_bol (Argentina BOL), argentina_un_stat (Argentina STAT). Fetch the full list with GET /v1/data/customs/shipments?expand=options.Origin countries to filter shipments by, as ISO 3166 alpha-3 codes (e.g. CHN, USA). Pick from the list; English country names are also accepted.248 allowed values, for example
AFG (Afghanistan), ALA (Aland Islands), ALB (Albania), DZA (Algeria), ASM (American Samoa), AND (Andorra), AGO (Angola), AIA (Anguilla), ATA (Antarctica), ATG (Antigua and Barbuda). Fetch the full list with GET /v1/data/customs/shipments?expand=options.Destination countries to filter shipments by, as ISO 3166 alpha-3 codes (e.g. CHN, USA). Pick from the list; English country names are also accepted.248 allowed values, for example
AFG (Afghanistan), ALA (Aland Islands), ALB (Albania), DZA (Algeria), ASM (American Samoa), AND (Andorra), AGO (Angola), AIA (Anguilla), ATA (Antarctica), ATG (Antigua and Barbuda). Fetch the full list with GET /v1/data/customs/shipments?expand=options.How many customs shipment records to return in total. Defaults to 50; use 0 for all.Max
500.Example
Response fields
Each row indata is one customs shipment record, keyed by these fields.
Example response
Abridged: long text and lists are shortened.Related APIs
For ranked importers and exporters of a product usecustoms/companies; for aggregate trade by HS code or country use customs/trade-stats.