Documents

List the documents of a shipment

Use this to see which paperwork Trackberry holds for a shipment (bill of lading, packing list, invoice, certificates) and whether each was read successfully. Only current documents are listed: replaced versions, reference-only attachments and internal page-split records are left out. Oldest first, not paged. Download a file with download_document_file when its downloadable is true.

get/shipments/{shipment_id}/documents

Request

  • Base URL: https://trackberry.com/api/v1
  • URL: https://trackberry.com/api/v1/shipments/{shipment_id}/documents
  • Auth: HTTP bearer

Path parameters

shipment_idstring required

The shipment id (shp_ prefix). An id from another organization, or with another prefix, is a 404.

Headers

Trackberry-Versionstring

The API version to build this response for, for example 2026-10-01. Optional: without it the organization's pinned version is used (and the organization is pinned to the latest version on its first request without the header). Applies to this request only. An unpublished version is a 400 with code invalid_version.

Response

The documents of the shipment.

object'list' required

Always list.

has_moreboolean required

True when more items exist after this page. Pass the last item's id as starting_after to fetch them. Always false for unpaged lists.

Changes

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