How do I switch a Cargoes Flow client to Dockflow?

How-to Q&A
1

My client calls the Cargoes Flow tracking API. What do I change to run it on Dockflow?

Two values:

  1. Change the host. A client that keeps its own path can use https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1
  2. Put a Dockflow API key in X-DPW-ApiKey. Create the key in the API Console with the Downstream scope. X-DPW-Org-Token is accepted and ignored.

No public specification exists to test against, so the first move to this surface runs together with Dockflow, as validation. Contact support to plan it.

A worked case, with a fake key:

POST /compat/cargoes-flow/createShipments
X-DPW-ApiKey: prod_acme_FAKE-TOKEN

{"uploadType":"FORM_BY_MBL_NUMBER","formData":[{"mblNumber":"MB-4471","oceanLine":"MAEU"}]}

Answer:

{"result":"SUCCESS","errorDetail":[],
 "shipments":[{"shipmentNumber":"DF74123","mblNumber":"MB-4471","created":true}]}

Rows are all or nothing: one bad row in formData means nothing is created, and the answer is FAILED with errorDetail on HTTP 200.

Read it with GET /shipments and shipmentNumber=DF74123. Add includeUniqueContainers=true for one row per box. Emissions and road legs stay empty. Each webhook delivery carries an X-Dockflow-Signature header.

Full field mapping and the signature check: