/importgenius/companies/shipments

POST /api/importgenius/companies/shipments

Price: 5 credits

List the most recent customs bill-of-lading filings of one business: arrival date, bill-of-lading number, the goods as described on the filing, the shipper and consignee with their own ImportGenius ids, quantity and unit, and gross and net weight.

How to use it

These are the latest filings the source publishes, newest first, so read them as a sample of activity rather than a count or total of trade, and date that activity by arrival_date and never by today: how far behind a market's customs data runs varies from days in the United States to years in Costa Rica, Vietnam and Venezuela, so an old newest filing is the market's coverage and not proof the business stopped trading. A bill-of-lading number is published in some markets and withheld in others, so a null bol is not a missing shipment, and a counterparty filed without a name carries no id. Rows are returned exactly as the source lists them, so one bill of lading can arrive as several lines that differ only in quantity or weight, and some markets repeat a line unchanged — an unchanged repeat shares its record_key, which identifies the filing by what it says rather than by where it sits in this window.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — ImportGenius business id as returned by search: importers/<alias> or suppliers/<alias> for United States customs records, <country>/<role>/<alias> for the other markets. A full importgenius.com profile URL also works (examples: "importers/walmart", "vietnam/suppliers/dongguan-yuyi-trading-co-ltd", "chile/exporters/patagonia-food-s-a"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 10)

Response

• @type string (default: "ImportgeniusShipment")
• record_key string required
• company string required
• bol string nullable
• entry_id string nullable
• arrival_date string nullable
• shipper object nullable
  • @type string (default: "ImportgeniusCounterparty")
  • name string required
  • id string nullable
  • alias string nullable
  • url string nullable
• consignee object nullable
  • @type string (default: "ImportgeniusCounterparty")
  • name string required
  • id string nullable
  • alias string nullable
  • url string nullable
• product_descriptions array (default: [])
• origin_country string nullable
• origin_country_english string nullable
• destination_country string nullable
• destination_country_english string nullable
• quantity number nullable
• quantity_unit string nullable
• gross_weight_kg number nullable
• gross_weight_lb number nullable
• net_weight_lb number nullable

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 — No ImportGenius profile under that id 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.