Dockflow API SDK for Python

The official Python client for the Dockflow API v3: container and shipment tracking events, tradeflows, documents and the tracking widget.

Install

pip install dockflow-sdk

Quickstart

Create an API key in the Dockflow console. Production is https://api.dockflow.com; test against the UAT sandbox at https://uat.dockflow.com with a UAT key.

import os
from dockflow_sdk import ApiClient, Configuration, UpstreamApi

config = Configuration(host="https://api.dockflow.com", access_token=os.environ["DOCKFLOW_KEY"])
with ApiClient(config) as client:
    page = UpstreamApi(client).get_upstream(tradeflow="PO4564268")

The four API classes are UpstreamApi, TradeflowsApi, DocumentsApi and WidgetApi.

Documentation

• Guides and examples: https://docs.dockflow.com/api/sdk/
• OpenAPI 3.1 spec: https://api.dockflow.com/v3/openapi.json
• All five SDKs (TypeScript, Python, C#, Java, PHP): https://github.com/Dockflow/dockflow-sdks

Versioning

Released automatically whenever the API changes. Versions follow semver: a breaking API change bumps the major version, everything else the minor or patch.

License

MIT