Get one value list, with shipment counts
Returns one list of names stored on US import shipments, such as countries or entry ports, and how many shipments use each name. The biggest counts come first. This call is free. The list parameter says which Power Query filter each list's values go in. Add search to find one spelling; results page like other routes.
Parameters#
Path parameters
liststringrequiredWhich list to return. countries → supplier_country, entry_ports → entry_port, shipping_ports → exit_port, bill_types → bol_type, carriers → carrier_scac_code. ssl_or_ff and quantity_units are not filters; they list the values of the ssl_or_ff and quantity_unit fields on each shipment.
one ofcountriesentry_portsshipping_portsbill_typesssl_or_ffquantity_unitscarriers
Query parameters
page_sizenumberoptionaldefault10Number of returned results
offsetnumberoptionaldefault0Results starting position
pagenumberoptionalPage number (1-indexed). Takes precedence over offset.
searchstringoptionalKeep only names that contain this text. Not case sensitive. For example, korea finds both South Korea and Republic Of Korea.
formatstringoptionaldefaultjsonResponse encoding. Defaults to
json. Passtoonto receive TOON — the same data in a compact, token-efficient text form intended for LLM prompts. Error responses are always JSON.one ofjsontoon
format works the same way as on other endpoints — Response shaping has worked examples.
Response#
Each stored value for that filter, with how many US import shipments use it. The biggest counts come first.
{
"requestCost": 0,
"creditsRemaining": 9998.5,
"data": {
"data": [
{
"entity": "China",
"shipments": 98981785
}
],
"totalCount": 59583
},
"executionTime": "224ms"
}Rows are nested one level deeper
PowerQuery routes put the records at data.data — not at data. The total number of matches is on data.totalCount, which is the value you page against. Note that this key is named per route family (totalCount, totalCompanies, totalSuppliers, totalBrokers).
Top-level fields#
data— an object holding the result rows (data.data) and the match total (data.totalCount)executionTime— How long the request tooktotalCount— Total matching records, not just this page
Fields on each row in data.data#
entitystringChinaThe stored name, exactly as it appears on shipments
shipmentsnumber98981785How many US import shipments use this name
Errors#
Failures come back as JSON with a statusCode and message. The ones worth handling here are 401 (bad or missing key), 403 (out of credits), and 404 (no such record). See all error responses.