Developers

Container and shipment tracking data in your own systems, through the Dockflow API v3 and official SDKs for five languages.

The API

  • JSON over HTTPS at https://api.dockflow.com, authenticated with one API key in the Authorization header.
  • Read milestone, shipment and location events per tradeflow, by polling or through webhooks.
  • Create and delete tradeflows by container, bill of lading or booking reference.
  • Upload and manage shipment documents, and embed the tracking widget.
  • The full contract is an OpenAPI 3.1 spec: api.dockflow.com/v3/openapi.json.

SDKs

Official client libraries, generated from the spec and published to each language's public registry.

LanguageInstallPackage
TypeScript / JavaScriptnpm install @dockflow/sdknpm
Pythonpip install dockflow-sdkPyPI
C# / .NETdotnet add package Dockflow.SdkNuGet
Javacom.dockflow:dockflow-sdkMaven Central
PHPcomposer require dockflow/dockflow-sdkPackagist

Source and release history: github.com/Dockflow/dockflow-sdks.

Quickstart

Read the events of one tradeflow in TypeScript. The other languages follow the same pattern; see the SDK guide.

import { Configuration, UpstreamApi } from "@dockflow/sdk";

const upstream = new UpstreamApi(
  new Configuration({
    basePath: "https://api.dockflow.com",
    accessToken: process.env.DOCKFLOW_KEY,
  }),
);
const page = await upstream.getUpstream({ tradeflow: "PO4564268" });

Sandbox

Build and test against the UAT environment at https://uat.dockflow.com with a UAT key, then switch the base URL and key for production. UAT guide.

Versions and updates

A new SDK version is released automatically when the API changes. Versions follow semver: a breaking change raises the major version, every other change the minor or patch version.

AI coding assistants

Give your assistant docs.dockflow.com/llms-full.txt, the full API documentation as one text file, together with the OpenAPI spec.

Read the API documentation or contact the Dockflow team about an integration.