POST
https://api.milda.ai/v1/trade-data/shipment-recipientsShipment Recipients
application/json01
Description
Trade Data — Shipment Recipients
POST /v1/trade-data/shipment-recipients
Ranked list of shipment recipients (importers that receive shipments from the candidate company), 10 per page. Use this to see who the company sells to.
Request
candidate_id(required) — from acandidatesresult.page_no(optional, default1) — page number; 10 recipients per page.
Response
List of recipients, ranked by trade volume. Each item includes: rank, id, name, domain, country {name, code, name_cn}, total_import_value, total_shipments, total_import_quantity, total_weight, import_countries, export_countries, loading_ports, unloading_ports, products.
Returns 204 No Content when the page has no recipients.
Credits
Charged a flat fee per page (data credits).
02
Headers
nameinreqdescription
tokenheaderone ofYour API token, sent as "token: YOUR_API_TOKEN". Send this or Authorization.
Authorizationheaderone ofThe same token in the standard form, sent as "Authorization: Bearer YOUR_API_TOKEN" (the word Bearer, a space, then your token). Send this or token.
03
Request body
TradePartnersRequestTradePartnersRequesttypereq2 fields
candidate_idstringyescandidate_id from a candidates result.
page_nointeger—Page number (10 partners per page).min 1 · default 1
04
Responses
200 Successful Response422 Validation Error
Returns a JSON array. Each item:
ImporterRecordtype14 fields
Company
rankinteger | nullRank by trade volume within the result set.
idstring | nullCandidate id of the importer.
namestring | nullImporter company name.
domainstring | nullImporter website domain.
+countryTradeCountry | nullImporter country.
namestring | null
codestring | null
name_cnstring | null
Volume
total_import_valuenumber | nullTotal import value across shipments (USD).
total_shipmentsinteger | nullTotal number of shipments.
total_import_quantitynumber | nullTotal imported quantity.
total_weightnumber | nullTotal shipment weight.
Routes
+export_countriesTradeCountry[]Origin (exporter) countries.
namestring | null
codestring | null
name_cnstring | null
+import_countriesTradeCountry[]Destination (importer) countries.
namestring | null
codestring | null
name_cnstring | null
loading_portsstring[]Ports of loading.
unloading_portsstring[]Ports of unloading.
Products
productsstring | nullFree-text summary of products traded.