FAQ – Qargo API: available options
Qargo offers APIs for order capture/status, load operations, master data sync and accounting across 3 roles: Tenant, Customer and Contract carrier.
Table of contents
Q. Does Qargo offer an API? If so, what functions are available?
A. Yes! Qargo offers an API for a number of functions across the platform. There are 3 roles to consider for the API, because each role affects how the integration is set up.
- Tenant: The integration is set up directly between Qargo and a third-party system.
- Customer: The integration is set up on a customer (of the Qargo account) and transfers data from the customer’s system to Qargo. For example, the customer may want to connect to the customer portal to submit orders.
- Contract carrier: The integration is set up on a contract carrier and transfers data from the contract carrier’s system to Qargo. For example, the contract carrier may want to send updates from its own TMS back to Qargo.
What is available?
Order capture and status / documents (tenant / customer)
-
Create orders from an external system (2 workflow options)
-
The customer (tenant) creates orders
-
The customer of the Qargo customer creates orders (customer portal)
-
-
Statuses to the external system
-
Two flows:
- Pull: the external system pulls the order status at order level (no stops)
- Push: Qargo pushes a real-time status update to the external system as a webhook
-
Load operations – send load / updates. (Contract carrier)
Qargo TMS API – Contract carrier specification document
-
Send the load assignment to the external system
- Create / update / cancel
-
Send (order) updates
- Stop date
- Freight details
- Canceled (removed) from load
-
Receive (load) updates
- Operations status at individual stop level
- Document updates (PODs)

Master data synchronization (tenant only)
Qargo TMS API specification document
Synchronization is bidirectional. It updates data coming into Qargo and sends updates from Qargo back to the third-party platform.
-
Sync customer and contract carrier data from the external system
- Creating, updating and archiving (deleting) customer data
-
Sync resources from the external system
- Create, update and archive (delete) availability for company fleet resources (drivers / vehicles)
- Example: when a new vehicle or driver is created in the third-party system, the new resource is added to the Qargo resources.
Accounting (tenant only)
Qargo TMS API specification document
-
Synchronize invoices and credit memos from Qargo to the external system
-
Update invoices from the external system
-
Update the payment status of invoices / credit memos
-
Carrier credit memos are now supported as well.
-
Block a customer (customer status: Prospect, etc.)

-
