Trade

Search Shipments

Beta
POST

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 100. Defaults to 100.
offsetintegerOptional
Number of results to skip before returning response. Defaults to 0.

Request

This endpoint expects an object.
q
stringRequired
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.
filter
objectOptional
Filters to be applied to search query to limit the result-set.
facets
booleanOptional
Whether or not to return search facets in results giving counts by field. Defaults to false.

Response

This endpoint returns an object
data
list of objects
limit
integer
next
boolean
offset
integer
size
object
POST
1curl -X POST "https://api.sayari.com/v1/trade/search/shipments?limit=1" \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "q": "rum"
6}'
200
Successful
1{
2  "data": [
3    {
4      "id": "KIB4wNCMtzLhG-onltADgQ",
5      "type": "shipment",
6      "buyer": [
7        {
8          "id": "M_vGQfA6PWYdNkj5a_XMNQ",
9          "names": [
10            "HEMINGWAY RUM COMPANY LLC"
11          ],
12          "risks": {
13            "basel_aml": 4.63,
14            "cpi_score": 67
15          },
16          "business_purpose": [],
17          "countries": [
18            "USA"
19          ]
20        }
21      ],
22      "supplier": [
23        {
24          "id": "9NQnfZhEFrRnp4YWk5yAVQ",
25          "names": [
26            "FOURSQUARE RUM DISTILLERY FOURSQUARE"
27          ],
28          "risks": {
29            "eu_high_risk_third": true,
30            "basel_aml": 5.81,
31            "cpi_score": 65
32          },
33          "business_purpose": [],
34          "countries": [
35            "BRB"
36          ]
37        }
38      ],
39      "monetary_value": [],
40      "weight": [
41        {
42          "value": 5388,
43          "unit": "kilogram",
44          "type": "gross_weight"
45        }
46      ],
47      "identifier": [
48        {
49          "value": "TSCW15541208",
50          "type": "bill_of_lading"
51        }
52      ],
53      "sources": [
54        {
55          "id": "16a4cc2d0f467fa993b28587d542a25d",
56          "label": "USA Imports (2021 - Present)"
57        }
58      ],
59      "hs_codes": [],
60      "product_descriptions": [
61        "0000000006FOURSQUARE 5YR OLD RUM"
62      ],
63      "record": "16a4cc2d0f467fa993b28587d542a25d/TSCW15541208/1653523200000/0",
64      "arrival_date": "2022-05-25",
65      "departure_date": "2022-05",
66      "departure_address": {
67        "x": -79.4861,
68        "y": 36.035,
69        "city": "ALAMANCE",
70        "state": "NC",
71        "value": "27201"
72      }
73    }
74  ],
75  "limit": 1,
76  "next": true,
77  "offset": 0,
78  "size": {
79    "count": 10000,
80    "qualifier": "gte"
81  }
82}
Built with