Alerts and checks

List document checks across shipments

Use this to find paperwork and data problems: missing documents, packing list totals that disagree with the declared ones, invalid container numbers, and similar. By default only checks that failed or warned are listed; pass status to see others. Across all shipments (archived ones included), newest first, keyset paged. Pass shipment to look at one shipment.

get/checks

Request

  • Base URL: https://trackberry.com/api/v1
  • URL: https://trackberry.com/api/v1/checks
  • Auth: HTTP bearer

Query parameters

statusstring[]

Only checks in one of these statuses. One comma-separated value. Defaults to failed,warning when omitted or empty. An unknown status is a 400.

shipmentstring

Only checks of this shipment. Must start with shp_; anything else is a 400. A well-formed id that is not in this organization simply matches nothing.

limitinteger

Maximum number of items in the page, 1 to 100. Decimal digits only; anything else (0, 101, 1e1, 0x10, a negative number) is a 400.

starting_afterstring

Cursor for the next page: the id of the last check of the previous page. Must start with chk_; anything else is a 400.

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

A page of checks, newest first.

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.