Shipments

List and search shipments

Use this to find shipments, to sync the whole book, or to answer questions like "what is arriving next week" (eta_after and eta_before) or "which shipments are in transit" (status). Newest first, keyset paged. Shipments still waiting for approval are never listed. Archived shipments are left out unless archived says otherwise. Each item is the full shipment object, the same as get_shipment. All parameters are optional and combine with AND.

get/shipments

Request

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

Query parameters

qstring

Free-text search. Case-insensitive, partial matches on the shipment reference, the ERP reference, the transport reference (bill of lading or air waybill number), the consignor and consignee names (also tolerant of small spelling differences), container numbers, and produce names (common aliases are understood). Spaces and dashes are ignored when matching transport references and container numbers, so MSCU 123456-7 finds MSCU1234567. An empty value means no search.

statusstring[]

Only shipments in one of these statuses. One comma-separated value. Repeating the parameter is not supported (only the last occurrence is used) and status[]= is a 400. The status error exists on shipments but cannot be filtered on. Omit to get every status.

labelsstring[]

Only shipments that carry all of these labels (AND, not OR). One comma-separated value of label ids (lbl_ prefix), as found in labels[].id on shipments. A malformed id is a 400.

archived'false' | 'true' | 'any'

Whether to include archived shipments. false (the default) lists only active ones, true only archived ones, any both.

string date-time
OR
string date

Only shipments created at or after this moment (inclusive). ISO 8601 date-time, or a bare date meaning midnight UTC at the start of that day.

string date-time
OR
string date

Only shipments created at or before this moment (inclusive). ISO 8601 date-time, or a bare date, which means midnight UTC at the start of that day: created_before=2026-09-30 excludes everything created after 00:00 UTC on 30 September. To include a whole day, pass the following day or a full date-time.

string date-time
OR
string date

Only shipments whose effective_eta is at or after this moment (inclusive). Shipments with no ETA at all never match once either eta_after or eta_before is given. ISO 8601 date-time or bare date (midnight UTC).

string date-time
OR
string date

Only shipments whose effective_eta is at or before this moment (inclusive). Same rules as eta_after, including the midnight rule for a bare date.

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 shipment of the previous page. Must start with shp_; 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 shipments, 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.