ImportYeti bill-of-lading records · ImportYeti API

GET https://api.api.sh/importyeti/v1/shipments

1 credit / call jobs & b2b try it in the playground →

Filter by partner country, words in the description or partner name, and a date range. Pass next_page back as page; null on the last page.

Every response includes credits_used: the credits this call cost.

Parameters

name	type	description
`slug`	string	Slug as in importyeti.com/company/<slug>, e.g. `nike-usa`. Example: `nike-usa`
`url`	string	An importyeti.com/company/<slug> or /supplier/<slug> link, instead of `slug`.
`type`	company \| supplier	company (default) for an importer, supplier for a foreign supplier.
`country`	string	Only records whose partner is in this country (name or 2-letter code).
`q`	string	Only records whose description or partner name contains these words.
`date_from`	string	Earliest shipment date, YYYY-MM-DD.
`date_to`	string	Latest shipment date, YYYY-MM-DD.
`size`	integer	Records per page (1-50, default 10).
`page`	integer	Page number. Pass `next_page` from the previous response.

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/importyeti/v1/shipments?slug=nike-usa" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/importyeti/v1/shipments",
    params={"slug": "nike-usa"},
    headers={"x-api-key": os.environ["APISH_KEY"]},
    timeout=120,
)
res.raise_for_status()
data = res.json()

const url = new URL("https://api.api.sh/importyeti/v1/shipments");
url.searchParams.set("slug", "nike-usa");

const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

Response

A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).

The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.