ImportYeti
PowerQuery
GET

Get one US export bill of lading

0.1 per BOL

Fetch a single US export BOL by bol or master bol number. Costs 0.1 data credits.

Parameters#

Path parameters

  • bolNumberstringrequired

    BOL or master BOL number

Query parameters

  • 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#

One US export bill of lading.

Response shape
{
  "requestCost": 0.1,
  "creditsRemaining": 9998.5,
  "data": {
    "data": [
      {
        "bol_number": "BSC2507BIOP2",
        "bol_bill_type": "R",
        "master_bol_number": "BSC2507BIOP2",
        "arrival_date": "07/27/2025",
        "lcl": false,
        "company_name": "Michelin North America Inc",
        "company_address": "One Parkway South 29615 Greenville Greenville, Sc Sc Us 29615",
        "company_country": "United States"
        // …16 more fields
      }
    ],
    "totalCount": 59583
  },
  "executionTime": "224ms"
}

Rows are nested one level deeper

PowerQuery routes put the records at data.data — not at data. The total number of matches is on data.totalCount, which is the value you page against. Note that this key is named per route family (totalCount, totalCompanies, totalSuppliers, totalBrokers).

Top-level fields#

  • data — an object holding the result rows (data.data) and the match total (data.totalCount)
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took
  • totalCount — Total matching records, not just this page

Fields on each row in data.data#

FieldExample
24 fields
  • bol_numberstringBSC2507BIOP2
  • bol_bill_typestringR

    Which filing this is: “R” for a regular (carrier-filed) bill, “H” for a house bill filed by a forwarder.

  • master_bol_numberstringBSC2507BIOP2

    The carrier-level bill this house bill rolls up to. House bills covering one master shipment share this value.

  • arrival_datestring07/27/2025
  • lclbooleanfalse

    Less than container load: the cargo shared a container with other shippers rather than filling its own.

  • company_namestringMichelin North America Inc
  • company_addressstringOne Parkway South 29615 Greenville Greenville, Sc Sc Us 29615
  • company_countrystringUnited States
  • company_country_codestringUS
  • company_total_shipmentsnumber18293
  • entry_portstringCharleston, Sc

    US port where cargo is received

  • exit_portstringThe Port Of Charleston, Charleston, South Carolina

    Foreign port where cargo is loaded for export

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.