Bills of Lading
GET

Get a US import bill of lading by number

0.1 per BOL

Fetch a single US import bill of lading (shipment document) by its BOL number. Costs 0.1 data credits per BOL returned.

Related:Search shipments with PowerQuery

Parameters#

Path parameters

  • numberstringrequired

Query parameters

  • fieldsstringoptional

    Comma-separated list of response fields to keep on each returned record. Every other field on the record is omitted. Names the record does not have are ignored. The envelope (requestCost, creditsRemaining, executionTime, totalCount) is always returned in full. Cannot be combined with exclude. Leave this out for the full record.

  • excludestringoptional

    Comma-separated list of response fields to drop from each returned record. Every other field is kept. Cannot be combined with fields. Leave this out 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 import bill of lading — the shipment document for that number.

Response shape
{
  "requestCost": 0.1,
  "creditsRemaining": 9998.5,
  "data": {
    "bol_number": "CCLLMILS17011590",
    "bol_type": "H",
    "inbond_type": "61 - IT: Immediate Transportation",
    "master_bol_number": "NYKSMILT12616400",
    "has_master_data": true,
    "company_manifest_confidentiality": false,
    "supplier_manifest_confidentiality": false,
    "arrival_date": "08/21/2017"
    // …95 more fields
  },
  "executionTime": "224ms"
}

Top-level fields#

  • data — the result object for this endpoint
  • requestCost — Data credits used for this call (0 if none)
  • creditsRemaining — Your data credit balance after the call
  • executionTime — How long the request took

Fields in data#

FieldExample
103 fields
  • bol_numberstringCCLLMILS17011590
  • bol_typestringH

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

  • inbond_typestring61 - IT: Immediate Transportation
  • master_bol_numberstringNYKSMILT12616400

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

  • has_master_databooleantrue
  • company_manifest_confidentialitybooleanfalse
  • supplier_manifest_confidentialitybooleanfalse
  • arrival_datestring08/21/2017
  • company_first_shipment_datestring07/04/2015
  • supplier_first_shipment_datestring08/01/2015

  • lat, lon

  • lat, lon

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.