Getting started
How Cargobase APIs fit together—and the shortest path from credentials to a successful request.
Cargobase exposes REST APIs so you can automate bookings, tracking, invoicing, and the operational workflows that sit around them. The same platform serves shippers integrating a TMS or ERP, providers exchanging milestones, and Cargobase staff operating internal tools.
Who this documentation is for
- Shippers create requests, manage shipments, and pull invoices from their own systems.
- Providers (carriers and logistics partners) receive work, emit tracking events, and exchange operational data.
- Cargobase staff use the Operations reference for API v4 and related web endpoints. Those docs require a staff login; calling the APIs still needs a valid credential.
Recommended path
- Request credentials via Get API access—start with Sandbox.
- Read Authentication so you know how to attach the token.
- Confirm Environments—Sandbox while you build, Production (
https://pluto.cargobase.com) when you go live. - Open the Shipper or Provider overview and try a call in the interactive reference.
- Download the OpenAPI Specification from any collection when you want codegen, Postman, or offline review.
Interactive reference
Each audience section embeds an API explorer. Authenticate once with your token, send requests against the live servers listed in the document, and inspect responses without leaving the docs.