/importgenius/companies/partners

POST /api/importgenius/companies/partners

Price: 5 credits

List the counterparties one business appears with on customs bill-of-lading filings: the name and filed address of each partner, its own ImportGenius id where it has a profile, how many shipments the pair shares, container counts, gross and net weight, the date of the most recent shipment between them, and whether the partner shipped to this business or received from it.

How to use it

partner_role tells the two directions apart: shipper sent goods to this business, consignee received them. shipment_count, container_count, the weights and last_shipment_date describe that one pairing; overall_shipment_count does not — it is a partner-level total the source publishes next to the pairing, and it matched the partner's own profile total on 6 of 14 ids checked and differed in both directions on the rest, so rank a relationship by shipment_count and read overall_shipment_count only as rough scale. Only the largest partners of each side are published, ranked by shipments, so treat these as the top of the relationship and never as a complete counterparty list. Argentina, Costa Rica, Uruguay and Venezuela publish no counterparties at all, and Chile and Peru publish them for only some businesses, so an empty answer in those markets is the source rather than a failed lookup. Where the filer gave no usable counterparty name the row still arrives, with is_name_withheld set and its shipment counts and dates intact.

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", "india/suppliers/dkh-retail-ltd", "peru/importers/endurance-food-s-a-c"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 20)

Response

• @type string (default: "ImportgeniusTradePartner")
• record_key string required
• company string required
• name string nullable
• is_name_withheld boolean nullable
• id string nullable
• alias string nullable
• url string nullable
• partner_role string required
• country string nullable
• country_code string nullable
• address string nullable
• address_english string nullable
• full_address string nullable
• shipment_count integer nullable
• overall_shipment_count integer nullable
• container_count integer nullable
• gross_weight_kg number nullable
• gross_weight_lb number nullable
• net_weight_lb number nullable
• last_shipment_date 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 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.