POST
https://api.milda.ai/v1/trade-data/shipping-recordsShipping Records
application/json01
Description
Trade Data — Shipping Records
POST /v1/trade-data/shipping-records
Individual import or export shipment records for a candidate company, 10 per page. Use this after candidates to drill into the raw shipments behind the analytics summary.
Request
candidate_id(required) — from acandidatesresult.type(required) —import(import shipments) orexport(export shipments).page_no(optional, default1) — page number; 10 records per page.start_date/end_date(optional) — filter shipments by date (YYYY-MM-DD), inclusive.
Response
List of shipment records. Each record includes: id, type, hs_code, hs_code_desc, bydate, importer/exporter country fields (country_imp, country_imp_cn, country_imp_en, country_exp, country_exp_cn, country_exp_en), amount, manifest_units, manifest_qty, weight_unit, weight, transport_type, export_id, shipper_name, import_id, consignee_name, products, start_port, end_port, is_shipping, or_country, brands.
Returns 204 No Content when the page has no records.
Credits
Charged a flat fee per page (data credits).
02
Headers
nameinreqdescription
tokenheaderyesAPI token. Issued per account; check it with GET /v1/credit-usage.
03
Request body
TradeRecordsRequestTradeRecordsRequesttypereq5 fields
candidate_idstringyescandidate_id from a candidates result.
type"import" | "export"yes'import' for import shipments, 'export' for export shipments.
page_nointeger—Page number (10 records per page).min 1 · default 1
start_datestring | null—Earliest shipment date, inclusive (YYYY-MM-DD).
end_datestring | null—Latest shipment date, inclusive (YYYY-MM-DD).
04
Responses
200 Successful Response422 Validation Error