Q. Does Qargo offer an API? If so, what functions are available?
A. Yes! Qargo offers API for a number of functions across the platform. When considering API, there are 3 roles that need to be considered as it will impact setting up the integration.
Tenant: This is where the integration will be set up directly between Qargo and a 3rd party system.
Customer: This is where the integration will be set up on a customer (of the Qargo account), and involve transferring data from their system to Qargo; for instance if they want to create a connection to the Customer Portal to submit orders.
Subcontractor: This is where the integration will be set up on a subcontractor, and involve transferring data from their system to Qargo; for instance if they want to submit updates from their own TMS back to Qargo.
What is available?
Order entry & status / documents (Tenant / Customer)
Create orders from external system (2 workflow options)
Customer (tenant) creates orders
Customer-of-our customer creates orders (Customer Portal)
Statuses to the external system
Two flows:
Pull: external system pulls the status of the order on order level (no stops)
Push: we push a realtime status update into the external system as a webhook
Trip execution - Send trip / Updates. (Subcontractor)
Send trip assignment to external system
Create / update / cancel
Send (order) updates
Stop date
Cargo details
Cancelled (removed) from trip
Receive (Trip) Updates
Execution status at individual stop level
Document updates (PODs)
Master data synchronisation (Tenant only)
Synchronisation is bi-directional and will update both incoming to Qargo and sending updates from Qargo back to the 3rd party platform.
Sync customer and subcontractor data from external system
Creating, updating, archiving (delete) customer data
Sync resources from external system
Create, Update & archive (delete) availability for owned fleet resources (drivers / vehicles)
Example: Create a new vehicle or driver in the 3rd party system, this new resource will be added to Qargo resources.
Accounting (Tenant only)
Synchronise invoices & credit notes from Qargo to external system
Update invoices from external system
Update payment status of invoices / credit notes
Purchase credit notes now supported as well.
Block customer (customer status - Prospect, etc)
