Skip to main content

Shipment Search

Shipment records may be retrieved by using the shipment search endpoint. Free-text queries and strict filters are available to select the appropriate shipment records, along with the sorting options detailed below.

Full Shipment Descriptions​

By default, the descriptions for shipments are capped to a limit of 200 characters. The parameter format.description may be set to full in order to retrieve the full length descriptions.

Sorting Shipment Results​

The parameter sorts controls the order by which shipment results are organized prior to being returned.

If multiple sorts are applied, they are successively applied according to their placement in the sort array. This is similar in concept to an ORDER BY in an SQL Query.

Sorts Example

In this example we are first sorting for shipments that have the smallest weight, followed by a sort to organize them by highest of estimated USD Value.

{
  "data_source": "global",
  "sort": [
    {
      "field": "weight_kg",
      "order": "asc"
    }, {
      "field": "value_usd",
      "order": "desc"
    }
  ] 
}
Selected Data-Source
string

Choose the desired data-source to view the available fields

field
required
string
Enum: "record_date" "consignee_name" "shipper_name" "value_usd" "weight_kg" "volume_teu" "relevance_score"
order
required
string
Enum: "asc" "desc"

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