Compatible with ShipsGo

Dockflow serves the ShipsGo v2 ocean API. A client switches by changing its base URL and the value of its token.

Book a demo

What changes

SettingNew value
Base URLhttps://api.dockflow.com/compat/shipsgo/v2
X-Shipsgo-User-TokenA Dockflow API key, created in the API Console

Paths, request bodies and response fields keep the ShipsGo v2 shape.

What is covered

CallWhat it does
POST /ocean/shipmentsCreates a shipment from a container or booking number, with an optional reference and carrier SCAC. A duplicate answers 409 ALREADY_EXISTS with the existing shipment.
GET /ocean/shipmentsLists shipments, with filters on id and container number.
GET /ocean/shipments/{id}Reads one shipment.
PATCH /ocean/shipments/{id}Changes one shipment.
DELETE /ocean/shipments/{id}Deactivates and removes one shipment.
GET /ocean/carriersLists the carriers by SCAC.
  • Container movements: EMSH, GTIN, LOAD, DEPA, ARRV, DISC, GTOT and EMRT, each with status ACT or EST.
  • Shipment status: NEW, INPROGRESS, BOOKED, LOADED, SAILING, ARRIVED, DISCHARGED and UNTRACKED.
  • Route: port of loading, port of discharge, transshipment count, transit time and transit percentage.
  • Errors: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 ALREADY_EXISTS and 422 VALIDATION_FAILED.
  • Webhook: OCEAN.SHIPMENTS.SHIPMENT_UPDATED, with the body {event, shipment} and the X-Shipsgo-Webhook-Signature header.
  • Response and error bodies are tested against the public ShipsGo v2 OpenAPI specification.

What is not covered

  • Air endpoints.
  • Followers and tags. Write calls answer 403 and reads return empty lists. GET .../geojson answers 404.
  • List filters other than id and container number, and every order_by. These answer 422.
  • SHIPMENT_CREATED and SHIPMENT_DELETED webhooks.
  • X-Shipsgo-Credits-* and X-RateLimit-* headers, tokens.map and route.co2_emission.
  • Ids issued by ShipsGo. Shipment ids come from Dockflow, so open shipments are registered again through the create call.

Request example

curl -X POST https://api.dockflow.com/compat/shipsgo/v2/ocean/shipments \
  -H "X-Shipsgo-User-Token: $DOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reference": "PO-1001", "container_number": "CSQU3054383"}'

Documentation

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

Other compatible APIs: project44, Windward, Cargoes Flow.

Book a demo

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

Book a demo