Skip to main content

API Documentation

The Dockflow API enables seamless integration with your systems to automate shipment data transmission and retrieve real-time tracking updates. Whether you're building an ERP integration, connecting a TMS, or creating custom applications, the Dockflow API provides the tools you need.

Overview​

The Dockflow API allows you to:

  • Send shipment data - Create and update tradeflows programmatically
  • Retrieve tracking updates - Get real-time shipment status and milestone information
  • Automate workflows - Integrate Dockflow data into your business processes
  • Build custom applications - Leverage Dockflow's tracking capabilities in your own tools
Complete API Documentation

This page provides a high-level overview. For comprehensive API documentation including:

  • Authentication methods
  • Endpoint specifications
  • Request/response examples
  • Rate limits and best practices
  • Webhook configuration
  • Error handling

Visit our complete API documentation at https://docs.dockflow.com

API Capabilities​

Sending Data to Dockflow​

Create shipments:

  • Submit booking and B/L information
  • Add container details
  • Specify origin and destination
  • Set expected dates and parties

Update shipments:

  • Modify existing tradeflow data
  • Add containers to shipments
  • Update reference numbers
  • Change dates or locations

Upload documents:

  • Attach bills of lading
  • Add commercial invoices
  • Upload customs documentation
  • Share supporting documents

Manage metadata:

  • Set custom fields
  • Add internal references
  • Tag shipments for categorization
  • Link to external systems

Retrieving Shipment Updates​

Query shipment status:

  • Get current location
  • Retrieve estimated and actual times
  • Check milestone completion
  • Access container-level details

Pull tracking events:

  • Departure confirmations
  • Arrival notifications
  • Discharge events
  • Gate movements

Access analytics:

  • Dwell time calculations
  • CO2 emissions data
  • Distance traveled
  • Transit time metrics

Download documentation:

  • Retrieve uploaded documents
  • Access generated reports
  • Export shipment data
  • Pull audit logs

Getting Started​

Prerequisites​

To use the Dockflow API:

  1. Active Dockflow account - Sign up at dockflow.com
  2. API credentials - Request API access from your account manager
  3. Development environment - Set up your integration tools
  4. Technical knowledge - Familiarity with REST APIs and HTTP protocols

API Access Request​

Contact your Dockflow account manager or support team to request API access:

Email: [email protected]

Information to provide:

  • Company name and account ID
  • Use case description (what you plan to integrate)
  • Expected API call volume
  • Technical contact information
  • Preferred authentication method
API Access Levels

API access may vary based on your subscription plan. Contact your account manager to discuss API capabilities included in your plan and any additional options.

Authentication​

The Dockflow API supports multiple authentication methods:

  • API Keys - Simple token-based authentication
  • OAuth 2.0 - Secure delegated access
  • JWT Tokens - For service-to-service communication

Detailed authentication instructions are available in the complete API documentation.

Common Integration Scenarios​

ERP Integration​

Connect your ERP system to automatically create shipments and receive updates:

Outbound flow (ERP → Dockflow):

  1. Order created in ERP
  2. ERP calls Dockflow API to create tradeflow
  3. Shipping details transmitted automatically
  4. Reference numbers linked between systems

Inbound flow (Dockflow → ERP):

  1. Shipment status updated in Dockflow
  2. Dockflow sends webhook to ERP
  3. ERP updates order status
  4. Inventory and logistics systems notified

Benefits:

  • Eliminate manual data entry
  • Real-time visibility in ERP
  • Automated status synchronization
  • Reduced errors and delays

TMS Integration​

Connect your Transportation Management System for comprehensive logistics visibility:

Use cases:

  • Auto-create shipments from TMS bookings
  • Pull tracking updates into TMS dashboard
  • Synchronize container and vessel information
  • Update delivery dates based on actual arrivals

Data exchanged:

  • Booking confirmations
  • Container assignments
  • Tracking milestones
  • Arrival/departure notifications
  • Document references

Custom Dashboard​

Build custom dashboards and reporting tools using Dockflow data:

Query capabilities:

  • Retrieve active shipments by date range
  • Filter by origin, destination, or carrier
  • Pull flagged or delayed shipments
  • Access environmental metrics

Visualization options:

  • Real-time status maps
  • Performance analytics
  • Exception reporting
  • KPI dashboards

Warehouse Management System​

Integrate with WMS for improved receiving and inventory planning:

Inbound notifications:

  • Vessel arrival alerts
  • Container discharge confirmations
  • Estimated arrival updates
  • Gate-out notifications

Warehouse preparation:

  • Pre-notify receiving based on ETA
  • Plan labor and space allocation
  • Coordinate container pickups
  • Schedule cross-dock operations

API Documentation Resources​

Primary Documentation​

📚 Complete API Reference: https://docs.dockflow.com

The comprehensive API documentation includes:

Getting Started Guide:

  • Authentication setup
  • First API call tutorial
  • Environment configuration
  • Testing and debugging

API Reference:

  • All available endpoints
  • Request parameters and formats
  • Response schemas and examples
  • HTTP status codes
  • Error messages

Webhooks:

  • Webhook configuration
  • Event types and payloads
  • Security and validation
  • Retry and error handling

Best Practices:

  • Rate limiting guidelines
  • Pagination strategies
  • Error handling patterns
  • Performance optimization
  • Security recommendations

Code Examples:

  • Sample requests in multiple languages
  • Integration patterns and templates
  • Common use case implementations
  • Troubleshooting guides

Additional Resources​

Postman Collection:

  • Pre-configured API requests
  • Environment templates
  • Test scripts
  • Available upon request from support

SDKs and Libraries:

  • Official client libraries (language support varies)
  • Community-contributed integrations
  • Code samples and starters

Developer Support:

  • Technical support via email: [email protected]
  • Developer community forum
  • Integration consultation services

Data Formats and Standards​

Request Format​

  • Content-Type: application/json
  • Character Encoding: UTF-8
  • Date Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
  • Timezone: UTC preferred, local time with timezone offset supported

Response Format​

  • Content-Type: application/json
  • HTTP Status Codes: Standard RESTful conventions
  • Error Format: Structured error objects with codes and messages
  • Pagination: Cursor-based or offset-based (endpoint-specific)

Data Standards​

Location codes:

  • UN/LOCODE for ports
  • IATA codes for airports
  • ISO 3166 country codes

Container identifiers:

  • ISO 6346 container number format
  • BIC code validation
  • Check digit verification

Date and time:

  • ISO 8601 format
  • UTC or timezone-aware timestamps
  • Support for estimated and actual times

Rate Limits and Quotas​

API access includes rate limiting to ensure system stability and fair usage.

Typical limits:

  • Requests per minute: Varies by plan
  • Requests per day: Varies by plan
  • Concurrent connections: Varies by plan

Rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1643673600

Handling rate limits:

  • Respect rate limit headers
  • Implement exponential backoff
  • Cache responses when appropriate
  • Batch requests where possible

Contact your account manager to discuss higher rate limits if needed.

Webhooks and Event Notifications​

Subscribe to real-time events via webhooks:

Available events:

  • Shipment created/updated
  • Milestone reached
  • Flag assigned
  • Document uploaded
  • Status change

Webhook configuration:

  • Set up webhook URLs in dashboard
  • Select events to subscribe to
  • Configure authentication and security
  • Test webhook delivery

Payload structure:

{
  "event": "milestone.reached",
  "timestamp": "2026-01-28T10:30:00Z",
  "data": {
    "tradeflow_id": "123456",
    "milestone": "container_discharge",
    "container": "ABCD1234567",
    "location": "Rotterdam Terminal"
  }
}

Webhook documentation available at https://docs.dockflow.com/webhooks

Security and Compliance​

The Dockflow API implements enterprise-grade security:

Data encryption:

  • TLS 1.2+ for all API traffic
  • Encrypted data at rest
  • Secure credential storage

Authentication:

  • API key or OAuth 2.0
  • Token expiration and rotation
  • IP whitelisting (optional)

Compliance:

  • GDPR compliant
  • SOC 2 Type II certified
  • ISO 27001 aligned

Best practices:

  • Never expose API keys in client-side code
  • Rotate credentials regularly
  • Use environment variables for secrets
  • Implement proper error handling to avoid information disclosure

Support and Resources​

Getting Help​

API Support:

  • Email: [email protected]
  • Response time: 24-48 hours for standard support
  • Priority support available for enterprise plans

Technical Documentation:

Integration Services:

  • Consultation available for complex integrations
  • Professional services team can assist with custom development
  • Partner program for integration partners and ISVs

Community and Updates​

Stay informed:

  • Subscribe to API changelog
  • Join developer mailing list
  • Follow release announcements

Contribute:

  • Report bugs or issues
  • Suggest API enhancements
  • Share integration examples

Next Steps​

Ready to integrate with Dockflow?

  1. Request API access - Contact your account manager or [email protected]
  2. Review complete documentation - Visit https://docs.dockflow.com
  3. Set up authentication - Configure API credentials
  4. Start developing - Build your first integration
  5. Test thoroughly - Use sandbox environment before production
  6. Deploy and monitor - Launch integration and track performance
Start with Read-Only Access

When beginning your integration, start with read-only API calls (GET requests) to familiarize yourself with the data structures before implementing write operations (POST, PUT, DELETE).

Frequently Asked Questions​

Q: Is there a sandbox environment for testing? A: Yes, a sandbox environment is available for testing integrations without affecting production data. Details in the complete API documentation.

Q: What's the API uptime SLA? A: SLA varies by subscription plan. Contact your account manager for specific SLA commitments. Historical uptime is available at status.dockflow.com.

Q: Can I use the API to manage user accounts? A: User management capabilities depend on your plan and permissions. Contact support to discuss user management API access.

Q: How quickly are API updates deployed? A: Non-breaking changes may be deployed continuously. Breaking changes are announced at least 90 days in advance via the API changelog.

Q: Is there GraphQL support? A: Currently, the Dockflow API is REST-based. GraphQL support is under consideration for future releases.

Q: Can I integrate with multiple Dockflow accounts via API? A: Yes, with separate API credentials for each account. Contact support to discuss multi-account integration patterns.

Q: Are there API client libraries for my programming language? A: Official SDKs are available for common languages. Check the complete documentation for current language support.

Q: How are API changes communicated? A: API changes are announced via email to registered API users, published in the changelog, and documented at docs.dockflow.com.

Start Building​

Begin your Dockflow API integration today by visiting our comprehensive documentation:

🚀 docs.dockflow.com​

Questions? Contact our API support team at [email protected]