Skip to main content

💻 Web-widget API - ad-hoc requests

Deprecation Notice

Heads‑up! This API is being sunset.

What this means for you​

  • Existing integrations keep working but no new features will be added.
  • Bug‑fixes and security patches are best‑effort only during the deprecation window.
  • After the sunset date, requests will return HTTP 410 (Gone).
  1. Migrate to our new API: see the Trident API for a step‑by‑step walkthrough.
  2. Update client libraries and SDKs to their latest major version.
  3. Reach out on [email protected] if you need help or an extension.

Thank you for building with us!
Your feedback has shaped the next generation of our platform, and we’re here to make the transition as smooth as possible.

Webwidget API​

Introduction 🌐​

The webwidget API is used for making easy on-the-spot requests for a specific reference.

Authentication 🔑​

To use the Dockflow API, you need to authenticate your requests using an API key. This ensures the security and privacy of your data.

Please include your API key in the request headers as follows:

Authorization: Basic YOUR_WIDGET_API_KEY

Example Request​

GET https://api.dockflow.com/api/v2/widget-search?query=YOUR_REFERENCE

YOUR_REFERENCE: Specify the reference you want to search for (e.g., order reference, PO, BL, booking, or container reference).

Response Example 📋​

Upon a successful request, you will receive a JSON response containing information related to the specified reference. Here's an example response:

{
    "carrier": "Hapag Lloyd",
    "booking_reference": "22025204",
    "bill_of_lading_reference": "HLCUBO1230937196",
    "departure": {
        "vessel": {
            "name": "ARGOLIKOS"
        },
        "event_date": "2023-09-28T00:48:00+00:00",
        "actual": true,
        "location": {
            "name": "IN Jawaharlal Nehru (Nhava Sheva)",
            "unlocode": "INNSA",
            "timezone": "Asia/Calcutta",
            "country": "India"
        }
    },
    "arrival": {
        "vessel": {
            "name": "ARGOLIKOS"
        },
        "actual": true,
        "event_date": "2023-10-06T16:15:00+00:00",
        "location": {
            "name": "SG Singapore",
            "unlocode": "SGSIN",
            "timezone": "Asia/Singapore",
            "country": "Singapore"
        }
    },
    "containers": [
        {
            "reference": "UACU4776849",
            "details": {
                "type_code": "45R1",
                "type_group": "45RT",
                "type_reefer": true,
                "length": 40
            },
            "latest_actual_milestone": {
                "vessel": null,
                "location": {
                    "name": "SG Singapore",
                    "unlocode": "SGSIN",
                    "timezone": "Asia/Singapore",
                    "country": "Singapore"
                },
                "event_date": "2023-10-09T09:37:00.000000Z",
                "actual": true,
                "status_code": "VD-F"
            }
        }
    ]
}

Feedback and Support 📧​

We value your feedback! If you have any questions, encounter issues, or want to share your experiences, please reach out to our support team at [email protected].

Thank you for choosing Dockflow for your maritime logistics needs. Happy coding! 🚀