Skip to main content
POST
/importyeti/companies

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
company
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
string
required
alias
string
required
role
string
required
url
string
required
@type
string
default:ImportyetiCompany
name
string | null
also_known_names
string[]
address
string | null
address_as_filed
string | null
address_url
string | null
address_shipments
integer | null
country_code
string | null
country
string | null
country_url
string | null
locations
object[]
website
string | null
other_websites
object[]
phone
string | null
email
string | null
total_shipments
integer | null
shipments_12m
integer | null
total_shipping_cost
number | null
shipping_cost_coverage
number | null
avg_teu_per_shipment
object | null
avg_teu_per_month
object | null
first_shipment_date
string | null
last_shipment_date
string | null
quarterly_growth_months
string[]
quarterly_growth_shipments
integer | null
quarterly_growth_share
number | null
monthly_shipments
object[]
shipping_delays
object[]
manifest_confidentiality
object[]
hs_codes
object[]
hts_codes
object[]
product_tags
object[]
containers
object[]
container_load_types
object[]
carriers
object[]
carriers_per_country
object[]
carrier_diversity
number | null
carrier_diversity_normalized
number | null
bill_types
object[]
origins
object[]
trade_lanes
object[]
notify_parties
object[]
notify_party_shipments
integer | null
notify_party_shipments_share
number | null
internal_notify_party_shipments
integer | null
internal_notify_party_shipments_share
number | null
has_internal_shipments
boolean | null
internal_partners_count
integer | null
companies_at_address_count
integer | null
other_addresses
object[]
contact_addresses
object[]
notify_party_addresses
object[]
trademarks
object[]
mexico_matches
object[]
is_uflpa_flagged
boolean | null
imports_per_country_image
string | null
top_relationships_image
string | null
shipments_over_time_image
string | null
product_breakdown_image
string | null