Bulk export all completed documents

Flattens every completed document (up to 1000, newest first) into normalized shipment-line rows — one row per container / invoice line / package / goods line. Corrected data wins. When more than 1000 documents exist the response carries x-export-truncated: true and x-export-row-cap headers.

get/api/bol/export

Request

  • Base URL: https://bol.ai
  • URL: https://bol.ai/api/bol/export
  • Auth: HTTP bearer

Query parameters

format'csv' | 'xlsx' | 'json' | 'customs'

csv = normalized master sheet; xlsx = the same as real Excel; json = TMS/ERP-ready rows; customs = customs-declaration draft from Bills of Lading

type'bill_of_lading' | 'commercial_invoice' | 'packing_list' | 'cmr'

Only include documents of this type

templatestring

Id of a saved column template (see /api/me/export-templates); applies to csv and xlsx

Response

The export. json format returns { count, truncated, row_cap, rows }; other formats return a file attachment.

Changes

No recorded changes to this operation across all 1 revision of this API.