Shipment Tracking

Tracking map data and checkpoints

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List tracking checkpoints for a shipment

GET/api/v1/shipment-tracking/checkpoints

Parameters

Name	In	Required	Type	Description
shipmentId	query	yes	string
page	query	no	integer
limit	query	no	integer

Responses

200 Checkpoint list

GET/api/v1/shipment-tracking/checkpoints

List tracking checkpoints for a shipment

API key (Bearer token)

shipmentId (query)

page (query)

limit (query)

https://api-test.orderly-hub.com/api/v1/shipment-tracking/checkpoints

Add a tracking checkpoint

POST/api/v1/shipment-tracking/checkpoints

Request body

Field	Type	Description
shipmentId	string
sequence	integer
status	string
statusDetail	string
description	string
city	string
state	string
country	string
countryCode	string
zip	string
latitude	number
longitude	number
checkpointTime	string
source	string
sourceEventId	string
rawData	object
isException	boolean
exceptionType	string

{
  "shipmentId": "550e8400-e29b-41d4-a716-446655440000",
  "sequence": 0,
  "status": "pending",
  "statusDetail": "string",
  "description": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "countryCode": "string",
  "zip": "94107",
  "latitude": 0,
  "longitude": 0,
  "checkpointTime": "2026-07-23T12:00:00Z",
  "source": "string",
  "sourceEventId": "550e8400-e29b-41d4-a716-446655440000",
  "rawData": {},
  "isException": true,
  "exceptionType": "string"
}

Responses

201 Checkpoint created

409 Duplicate checkpoint

POST/api/v1/shipment-tracking/checkpoints

Add a tracking checkpoint

API key (Bearer token)

Request body (JSON){ "shipmentId": "550e8400-e29b-41d4-a716-446655440000", "sequence": 0, "status": "pending", "statusDetail": "string", "description": "string", "city": "string", "state": "string", "country": "string", "countryCode": "string", "zip": "94107", "latitude": 0, "longitude": 0, "checkpointTime": "2026-07-23T12:00:00Z", "source": "string", "sourceEventId": "550e8400-e29b-41d4-a716-446655440000", "rawData": {}, "isException": true, "exceptionType": "string" }

https://api-test.orderly-hub.com/api/v1/shipment-tracking/checkpoints

Batch upsert tracking checkpoints

POST/api/v1/shipment-tracking/checkpoints/batch

Request body

Field	Type	Description
checkpoints	array

{
  "checkpoints": [
    {}
  ]
}

Responses

201 Checkpoints upserted

POST/api/v1/shipment-tracking/checkpoints/batch

Batch upsert tracking checkpoints

API key (Bearer token)

Request body (JSON){ "checkpoints": [ {} ] }

https://api-test.orderly-hub.com/api/v1/shipment-tracking/checkpoints/batch

Get shipments with coordinates for map

GET/api/v1/shipment-tracking/map

Parameters

Name	In	Required	Type	Description
status	query	no	string
bridgeId	query	no	string
limit	query	no	integer

Responses

200 Map data

GET/api/v1/shipment-tracking/map

Get shipments with coordinates for map

API key (Bearer token)

status (query)

bridgeId (query)

limit (query)

https://api-test.orderly-hub.com/api/v1/shipment-tracking/map