/importyeti/companies/partners

POST /api/importyeti/companies/partners

Price: 20 credits

List the trading partners recorded against one business in US ocean import bills of lading, ranked by shipment volume. For a US importer these are its foreign suppliers; for a foreign supplier these are its US customers. Each partner carries its own ImportYeti id, name, address, country, shipments over the whole record and over the last 12 months, weight and TEU totals, the HS codes and goods descriptions moved on that relationship, an HS chapter breakdown, the partner's own largest counterparties, a month-by-month shipment history for the pair, and the UFLPA forced-labour flag.

How to use it

Use this to walk a supply chain: every partner's `id` feeds straight back into /importyeti/companies or into this endpoint again, so importer -> supplier -> that supplier's other customers is three calls. `role` on each row tells you which side you landed on, and `total_shipments` counts the whole partner rather than just the pair. The public tier serves the leading partners by volume, so read the list as the head of the ranking rather than the complete set. A row with is_name_withheld true is a real relationship whose business name the source did not publish: its volumes and commodities are intact, but it carries no name and no id to walk to.

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: 50)

Response

• @type string (default: "ImportyetiTradePartner")
• name string nullable
• is_name_withheld boolean nullable
• id string nullable
• alias string nullable
• role string nullable
• url string nullable
• address string nullable
• location string nullable
• location_url string nullable
• country string nullable
• country_code string nullable
• country_url string nullable
• total_shipments integer nullable
• shipments_12m integer nullable
• total_weight integer nullable
• total_teu integer nullable
• hs_codes array (default: [])
• hs_chapters array (default: [])
  • @type string (default: "ImportyetiHsChapterShare")
  • chapter string required
  • name string nullable
  • shipments integer nullable
  • shipments_share number nullable
  • weight integer nullable
  • weight_share number nullable
  • teu integer nullable
  • teu_share number nullable
• product_description string nullable
• top_partners array (default: [])
  • @type string (default: "ImportyetiTopPartner")
  • name string required
  • total_shipments integer nullable
  • shipments_12m integer nullable
• monthly_shipments array (default: [])
  • @type string (default: "ImportyetiPartnerMonthlyPoint")
  • date string required
  • shipments integer nullable
  • weight integer nullable
  • teu integer nullable
• is_internal boolean nullable
• is_uflpa_flagged boolean nullable
• uflpa_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.