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
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
TradeRecordsRequestTradeRecordsRequesttypereq5 fields
candidate_idstringyescandidate_id from a candidates result.
type"import" | "export"yes'import' for import shipments, 'export' for export shipments.
start_datestring | null—Earliest shipment date, inclusive (YYYY-MM-DD).
end_datestring | null—Latest shipment date, inclusive (YYYY-MM-DD).
page_nointeger—Page number (10 records per page).min 1 · default 1
04
Responses
200 Successful Response422 Validation Error
Returns a JSON array. Each item:
ShippingRecordtype27 fields
Shipment
idstring | nullUnique shipment record identifier.
typestring | nullRecord direction: 'imp' (import) or 'exp' (export).
bydateinteger | nullShipment date as an integer in YYYYMMDD form.
transport_typestring | nullMode of transport.
is_shippinginteger | nullWhether the record is a shipping (sea) record (1) or not (0).
Exporter
export_idstring | nullCandidate id of the exporter (shipper).
shipper_namestring | nullName of the shipper (exporter).
country_expstring | nullExporter country (two-letter ISO 3166-1 alpha-2 code where resolvable).
country_exp_enstring | nullExporter country name in English.
country_exp_cnstring | nullExporter country name in Chinese.
start_portstring | nullPort of loading.
Importer
import_idstring | nullCandidate id of the importer (consignee).
consignee_namestring | nullName of the consignee (importer).
country_impstring | nullImporter country (two-letter ISO 3166-1 alpha-2 code where resolvable).
country_imp_enstring | nullImporter country name in English.
country_imp_cnstring | nullImporter country name in Chinese.
end_portstring | nullPort of unloading.
Goods
productsstring | nullFree-text description of the shipped products.
brandsstring | nullBrands associated with the shipment.
hs_codestring | nullHarmonized System (HS) commodity code.
hs_code_descstring | nullDescription of the HS commodity code.
or_countrystring | nullCountry of origin of the goods.
amountnumber | nullDeclared customs value of the shipment (USD).
manifest_qtynumber | nullQuantity declared on the manifest.
manifest_unitsstring | nullUnit of the manifest quantity.
weightnumber | nullShipment weight.
weight_unitstring | nullUnit of the shipment weight.