ImportYeti
Suppliers
GET

List bills of lading for a supplier

1 per 10 records

Paginated US import BOLs linked to an overseas supplier slug. Costs 1 data credit per 10 records.

Parameters#

Path parameters

  • supplierstringrequired

    ImportYeti supplier URL slug — the hyphenated segment from the website path /supplier/... (e.g. yiwu-yida-import-and-export-co-ltd), not the supplier display or legal name. To resolve a name to a slug, use GET /supplier/search. Slugs use lowercase letters, digits, and hyphens; letter casing in this parameter is normalized. Underscores are accepted in place of hyphens.

Query parameters

  • start_datestringoptionaldefault 01/01/2021
  • end_datestringoptionaldefault 08/31/2026
  • page_sizenumberoptionaldefault 10

    Number of returned results

  • offsetnumberoptionaldefault 0

    Results starting position

  • fieldsstringoptional

    Comma-separated list of fields to keep on each returned record, e.g. bol_number,arrival_date,supplier_name. Everything else is omitted. Names that the record does not carry are ignored. The envelope (requestCost, creditsRemaining, executionTime, totalCount) is always returned in full. Cannot be combined with exclude. Omit for the full record.

  • excludestringoptional

    Comma-separated list of fields to drop from each returned record, e.g. containers,shipping_rate. Every other field is kept. Cannot be combined with fields. Omit for the full record.

  • formatstringoptionaldefault json

    Response encoding. Defaults to json. Pass toon to receive TOON — the same data in a compact, token-efficient text form intended for LLM prompts. Error responses are always JSON.

    one ofjsontoon

fields, exclude, and format work the same way on every endpoint — Response shaping has worked examples.

Response#

A page of US import bills of lading for that supplier.

Response shape
{
  "requestCost": 1,
  "creditsRemaining": 9998.5,
  "data": ["CCLLMILS17011590", …],
  "executionTime": "224ms"
}

Top-level fields#

  • data — an array where each item is a bill of lading number
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took

data is an array of string values — each one is a bill of lading number. Pass one to GET /v1.0/bol/{number} to expand it into the full shipment record.

Errors#

Failures come back as JSON with a statusCode and message. The ones worth handling here are 401 (bad or missing key), 403 (out of credits), and 404 (no such record). See all error responses.