/importyeti/companies/shipments

POST /api/importyeti/companies/shipments

Price: 20 credits

List the most recent US ocean import bills of lading filed against one business, newest first. Each row carries the bill of lading number with its master and house numbers, arrival date, bill type, goods description, gross weight, piece count and unit, container count, the shipping route, an estimated shipping cost and, where the record is a CIF entry, the declared value. The counterparty on the other side of each shipment comes with its own ImportYeti id, name, address and country.

How to use it

This is a recency window, not the full manifest: the public tier serves only the newest bills of a history that often runs to thousands, so never total these rows to size a business — ask /importyeti/companies for the aggregates over the whole record. Rows with is_partial_record true carry a shortened goods description rather than the text as filed, and declared_value appears only on the CIF entries, so its absence is not a value of zero.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — ImportYeti business id as returned by search: company/<slug> for a US importer or supplier/<slug> for a foreign counterparty. A full importyeti.com profile URL also works (examples: "company/nike-ihm", "supplier/kiefel", "https://www.importyeti.com/company/wal-mart"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 100)

Response

• @type string (default: "ImportyetiShipment")
• bol string required
• date string nullable
• bill_code string nullable
• bill_type string nullable
• master_bol string nullable
• house_bol string nullable
• description string nullable
• weight integer nullable
• quantity string nullable
• quantity_unit string nullable
• containers_count integer nullable
• shipping_route string nullable
• shipping_cost number nullable
• declared_value number nullable
• is_partial_record boolean nullable
• counterparty object nullable
  • @type string (default: "ImportyetiCounterparty")
  • id string nullable
  • role string nullable
  • url string nullable
  • name string nullable
  • address string nullable
  • location string nullable
  • location_url string nullable
  • country string nullable
  • country_code string nullable
  • country_url string 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 ImportYeti profile under that id, on either the company or the supplier side 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.