Documents

Get one document

Use this to describe a document you found through list_shipment_documents: its type, file name, size, source, processing status, and whether extracted data is available. download_document_file returns the file itself. Only current documents are found; a replaced or reference-only document is a 404.

get/documents/{id}

Request

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

Path parameters

idstring required

The document id (doc_ prefix). An id from another organization, with another prefix, or of a document that is not current, 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 document.

object'document' required

Always document.

idstring required

The document id.

shipment_idstring required

The shipment the document belongs to.

type'unknown' | 'packing_list' | 'transport_document' | 'invoice' | 'phytosanitary_cert' | 'merged_document' | 'certificate_of_origin' | 'warehouse_receipt' | 'inspection_report' | 'courier_document' | 'other_certificate' | 'arrival_notice' | 'booking' | 'pre_alert' required

What kind of document Trackberry decided it is. transport_document covers bills of lading, air waybills and road consignment notes; merged_document is a single file holding several kinds; unknown means it could not be classified.

filenamestring nullable required

The file's name. Null when no file is attached.

content_typestring nullable required

The file's MIME type. Null when no file is attached.

byte_sizeinteger nullable required

The file size in bytes. Null when no file is attached.

source'manual_upload' | 'email_upload' | 'api' | 'correction_link' required

How the document reached Trackberry. manual_upload was uploaded in the app; email_upload arrived by email; api came in through an integration; correction_link was sent in answer to a correction request.

parse_status'pending' | 'processing' | 'parsed' | 'failed' required

Whether Trackberry has read the document. pending and processing are in progress; parsed means data was extracted; failed means reading failed.

downloadableboolean required

True when a file is attached and passed the security scan, so GET /documents/{id}/file serves it.

page_rangestring nullable required

For a document split out of a larger multi-document PDF, the pages of the original file it covers, like 3-5 or 7. Null for documents that are whole files.

data_availableboolean required

True when get_document_data will return extracted fields for this document.

created_atstring date-time required

When the document was added to Trackberry.

updated_atstring date-time required

When the document record last changed.

Changes

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