/panjiva/shipments/search

POST /api/panjiva/shipments/search

Price: 10 credits

Search US customs import bill-of-lading records by free text, optionally narrowed to shippers or US buyers within a radius of a point. Each record carries the arrival date, which fields matched the query, the shipper Panjiva names for it together with whatever contact details it publishes, quantity, weight in kilograms, and the goods description and marks of each container.

How to use it

Use it to pull individual US import shipments and the foreign shippers behind them. It answers with the newest arrivals only — on a broad query all 20 rows share one arrival date and their country mix is nothing like the matching set's — so narrow by shipper or buyer radius rather than reading the rows as a sample. No buyer column is served, but a query hitting a consignee or notify-party field brings that name back inside matches. Take shipper.company_id into /panjiva/companies to profile a supplier.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shipper_latitude number nullable — Latitude of the point the foreign shipper must sit near; send it together with shipper_longitude and shipper_radius_km (examples: 31.2304; min: -90; max: 90)
• shipper_longitude number nullable — Longitude of that same point (examples: 121.4737; min: -180; max: 180)
• shipper_radius_km integer nullable — How far from that point, in kilometres, the shipper may be; Panjiva's own map offers 10 to 1000 (examples: 50; min: 1; max: 5000)
• consignee_latitude number nullable — Latitude of the point the US buyer must sit near; send it together with consignee_longitude and consignee_radius_km (examples: 40.7128; min: -90; max: 90)
• consignee_longitude number nullable — Longitude of that same point (examples: -74.006; min: -180; max: 180)
• consignee_radius_km integer nullable — How far from that point, in kilometres, the buyer may be; Panjiva's own map offers 10 to 1000 (examples: 50; min: 1; max: 5000)
• query string nullable — Free text matched against goods descriptions, company names, addresses and HS codes (examples: "furniture", "Walmart", "9401"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 20)

Response

• @type string (default: "PanjivaShipment")
• id string required
• arrival_date string nullable
• is_masked boolean (default: false)
• matches array (default: [])
  • @type string (default: "PanjivaShipmentMatch")
  • field string required
  • value string nullable
• shipper object nullable
  • @type string (default: "PanjivaShipmentParty")
  • company_id string nullable
  • url string nullable
  • name string nullable
  • address string nullable
  • email string nullable
  • phone string nullable
  • website string nullable
  • trade_roles array (default: [])
• quantity number nullable
• quantity_unit string nullable
• weight_kg number nullable
• container_count integer nullable
• containers array (default: [])
  • @type string (default: "PanjivaShipmentContainer")
  • goods_shipped string nullable
  • marks string nullable
  • is_masked boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.