API

Developer API for InboundShipments (Coming Soon)

Access your inbound shipment data programmatically. Our roadmap includes REST API endpoints, webhook notifications, and scoped authentication. CSV import and export is available today for immediate data exchange, with direct API access coming soon.

Planned API Capabilities

CSV export is available today. REST endpoints, webhooks, and developer tools are on the roadmap.

Planned REST API Endpoints

Our roadmap includes a comprehensive REST API covering shipments, purchase orders, invoices, items, contacts, and containers. Endpoints will follow standard REST conventions with JSON request and response bodies.

Upcoming Webhook Notifications

We are designing a webhook system that will push real-time events to your systems when shipments change status, containers reach milestones, invoices are extracted, or goods are received.

CSV Export (Available Today)

CSV export is available right now for shipments, purchase orders, invoices, and contacts. This is the primary data exchange method today and will continue to be supported alongside the API.

Planned API Authentication

The API will use API key authentication with scoped permissions, so you can create keys with access limited to specific resources. OAuth 2.0 support is also being evaluated for the roadmap.

Upcoming Developer Documentation

We are planning interactive API documentation with request and response examples, authentication guides, rate limit details, and code samples in popular languages.

Planned Rate Limiting and Monitoring

The API will include rate limiting to ensure fair usage, along with a dashboard to monitor API call volume, error rates, and webhook delivery status for your integrations.

Why a Developer API Matters for Your Supply Chain

Programmatic access to shipment data unlocks automation, custom integrations, and real-time workflows across your tech stack.

1

Build custom integrations with any system

The planned REST API will allow you to connect InboundShipments with any system your organization uses, whether it is an ERP, WMS, TMS, BI tool, or a custom internal application. If your system can make HTTP requests, it will be able to exchange data with InboundShipments.

2

Automate workflows that currently require manual steps

With webhooks and API endpoints, you will be able to automate common workflows like creating shipments when POs are approved in your ERP, updating your WMS when containers reach port, or triggering alerts when demurrage free time is running low.

3

CSV export works today as a bridge

You do not need to wait for the API to start moving data. CSV export is available today for shipments, purchase orders, invoices, contacts, and items. Many teams use CSV export to feed data into spreadsheets, BI tools, or ERP import processes while the API is being developed.

4

Real-time event notifications through webhooks

Rather than polling for changes, the planned webhook system will push events to your endpoints as they happen. This enables real-time reactions to shipment milestones, document uploads, receiving confirmations, and other critical supply chain events.

5

Secure, scoped access to your data

The planned API authentication will let you create multiple API keys with different permission scopes. This means your warehouse integration only accesses receiving data, your finance integration only accesses invoice data, and your tracking dashboard only reads shipment statuses.

Questions About the Developer API

Start using InboundShipments today

CSV export is available now. Track shipments, extract invoices with AI, and monitor containers while the API is being built.