Compatible with Cargoes Flow

Dockflow serves a REST API in the shape of the Cargoes Flow public tracking API. A client switches by changing its base URL and the value of its API key.

Book a demo

What changes

Setting	New value
Base URL	`https://api.dockflow.com/compat/cargoes-flow`
`X-DPW-ApiKey`	A Dockflow API key, created in the API Console
`X-DPW-Org-Token`	Accepted and ignored.

The path /flow/api/public_tracking/v1 also works under that base URL, so a client that only swaps the host needs no path change.

The first migration to this API runs together with Dockflow.

What is covered

Call	What it does
`GET /shipments`	Lists shipments as a bare array. Filters: `shipmentType`, `status`, `shipmentNumber`, `mblNumber`, `containerNumber`, `awbNumber`, `search`, `includeUniqueContainers`, `_page` and `_limit`.
`POST /createShipments`	Creates shipments from `formData` rows with upload type `FORM_BY_MBL_NUMBER`.
`PUT /updateShipments`	Updates shipper, consignee and extra fields on an existing shipment.
`POST /uploadDocument`	Stores documents on a shipment, as multipart `files` plus `shipmentNumber`.
`GET /mapRoutes`	Returns the legs of a `shipmentNumber` as `routes`. The list is empty until a transport plan exists.
`GET /carrierList`	Lists the carriers.

Granularity: one MBL is one shipment. With includeUniqueContainers or a containerNumber filter, the answer has one row per container.
Events: gateOutEmpty, gateInFull, loadedOnVessel, vesselDeparture, vesselArrival, dischargeFromVessel, gateOutFull, delivered and gateInEmpty.
Status ACTIVE or COMPLETED, with subStatus1 and subStatus2 from the latest actual event.
Legs in shipmentLegs.portToPort, with ports, dates and segments.
Update failures as result: FAILED with errorDetail[].error on HTTP 200.

What is not covered

Create by anything other than FORM_BY_MBL_NUMBER, and tracking by booking number.
Deleting a shipment.
emissions.co2e.value is null and shipmentLegs.road is empty.
Shipment numbers issued by Cargoes Flow. On Dockflow a shipment number has the form DF<id>, so open shipments are registered again through the create call.

Request example

curl "https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1/shipments?containerNumber=CSQU3054383" \
  -H "X-DPW-ApiKey: $DOCKFLOW_API_KEY"

Documentation

The mapping of fields and events is in the Cargoes Flow migration guide.

Other compatible APIs: ShipsGo, project44, Windward.

Book a demo

Go through your integration and the switch with the Dockflow team.

Book a demo