This endpoint is in beta and is subject to change. It is provided for early access and testing purposes only.
Search for a shipment. Please note, searches are limited to a maximum of 10,000 results.
Query parameters
limitintegerOptional
A limit on the number of objects to be returned with a range between 1 and 10000. Defaults to 100.
offsetintegerOptional
Number of results to skip before returning response. Defaults to 0.
Request
This endpoint expects an object.
qstringRequired
Query term. The syntax for the query parameter follows elasticsearch simple query string syntax. The includes the ability to use search operators and to perform nested queries. Must be url encoded.
filterobjectOptional
Filters to be applied to search query to limit the result-set.
facetsbooleanOptional
Whether or not to return search facets in results giving counts by field. Defaults to false.