Skip to main content

Company Search

Company entities may be searched for and retrieved through the company search endpoint. If a company identifier is already known, the company entity may be directly retrieved by using the company lookup endpoint.

How company search operates​

The company search functions by first searching for shipments that match the provided criteria specified using Free-text queries and strict filters. From these, the company entities found on the shipments are aggregated into the respective shippers and consignees buckets and only the company entities (not the shipment-level attributes of the shipments), are returned.

note

If a company is found as both the shipper and receiver on shipments the particular search, then they may be present in both shipper and consignee buckets.

note

When using free-text queries, the default field group includes only the name, address, and industry type.

tip

For advanced requirements, it may be desirable to use the shipment-rollup endpoint directly in order to categorize shipments by different company attributes or perform many levels of aggregations.

Record Count

The record_count listed for each company is not representative of all shipments that exist for that company, but is instead the amount of the company's shipment records that matched the provided selection criteria.

Sorting Company Results​

Since the company search acts as a rollup aggregation on shipments, sorting company results is possible by providing a rollup sort.

Selected Data-Source
string

Choose the desired data-source to view the available fields

key
string
Enum: "count" "field" "value_usd" "weight_kg" "volume_teu" "relevance_score"

This parameter controls the sorting of a parent rollup or aggregation.

Note: If specifying a metric that is not field or count, that metric and op must be defined in the top-level metrics object.

order
string
Enum: "asc" "desc"

The sort order, either 'asc' for ascending or 'desc' for descending.

op
string
Enum: "sum" "max" "avg" "min"