Models

Data models and enum values returned in endpoint responses.

---

Firm

Field	Type	Description
country	string	Full country name
country_code	string	ISO 2-letter country code
name	string	Firm name
address	string	Registered address
city_state	string	City and state
tel	string	Phone number
fax	string	Fax number
e_mail	string	Email address
web	string	Website URL
linkedin	string	LinkedIn profile URL
facebook	string	Facebook page URL
instagram	string	Instagram profile URL
twitter	string	Twitter/X profile URL
firm_type	integer	Internal firm type code
shipment_count	integer	Number of shipments associated with this firm

Null fields are omitted from the response.

---

Shipment

A shipment record representing a single trade movement.

Field	Type	Description
importerName	string	Importer company name
importerCountry	string	Importer country full name
importerCountryCode	string	Importer ISO 2-letter country code
importerAddress	string	Importer company address
importerCityState	string	Importer city and state
importerEmail	string	Importer email address
importerTel	string	Importer phone number
importerWeb	string	Importer website
exporterName	string	Exporter company name
exporterCountry	string	Exporter country full name
exporterCountryCode	string	Exporter ISO 2-letter country code
exporterAddress	string	Exporter company address
exporterCityState	string	Exporter city and state
exporterEmail	string	Exporter email address
exporterTel	string	Exporter phone number
exporterWeb	string	Exporter website
hsCode	string	Harmonized System product code
hsCodeDescription	string	HS code product description
arrivalDate	string	Shipment arrival date
portOfArrival	string	Port of arrival
portOfDeparture	string	Port of departure
grossWeight	string	Gross weight
grossWeightUnit	string	Gross weight unit (e.g., KG)
netWeight	string	Net weight
netWeightUnit	string	Net weight unit
quantity	string	Quantity value
quantityUnit	string	Quantity unit
fobValue	string	FOB trade value
fobCurrency	string	FOB currency code
usdFob	string	FOB value converted to USD
cifValue	string	CIF trade value
cifCurrency	string	CIF currency code
usdCif	string	CIF value converted to USD
brandName	string	Brand name declared on the shipment
productDetails	string	Detailed product description
transportType	string	Mode of transport
vesselName	string	Vessel or carrier name
incoterms	string	Trade terms (e.g., FOB, CIF, EXW)
paymentType	string	Payment method
declarationNumber	string	Customs declaration number
billOfLadingNo	string	Bill of lading number
countryOfOrigin	string	Country of manufacture
dataType	string	Data source type — see DataType
importerDataType	string	Importer data classification — see ImporterExporterDataType
exporterDataType	string	Exporter data classification — see ImporterExporterDataType

---

SearchType

Specifies the trade direction to filter by.

Value	Description
"importer"	Filter by importing firms or countries
"exporter"	Filter by exporting firms or countries

---

DataType

Source type of the shipment record.

Value	Description
""	Not specified
"Custom Data"	Customs authority data
"Bill of Landing"	Bill of lading data
"Transit"	Transit shipment data
"Trade Registry"	Trade registry data

---

ImporterExporterDataType

Data classification for the importer or exporter side of a shipment.

Value	Description
""	Not specified
"Direct Import"	Directly imported goods
"Mirror Import"	Mirror statistics for imports
"Direct Export"	Directly exported goods
"Mirror Export"	Mirror statistics for exports
"Bill of Lading"	Bill of lading data
"Transit Data"	Transit shipment
"Trade Registry"	Trade registry entry