Shipments

Get the map data of a shipment

Use this to draw a shipment's voyage on a map: the sea or air route split into the part already travelled and the part remaining, the carrier's ports, the vessel's upcoming calls, the recorded position trail and the vessel marker. It is the data behind the map on the shipment's page in Trackberry. Long lines are thinned and coordinates rounded to four decimals. When the carrier has published nothing to draw, map has the same shape and draws the shipment's legs between the places its own located tracking events put their ends; it is null only when nothing can be placed. Not paged.

get/shipments/{shipment_id}/map

Request

  • Base URL: https://trackberry.com/api/v1
  • URL: https://trackberry.com/api/v1/shipments/{shipment_id}/map
  • 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 map data of the shipment.

object'shipment_map' required

Always shipment_map.

shipment_idstring required

The shipment this map belongs to.

Changes

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