---
title: "FAQ – Qargo API: available options"
description: "Qargo offers APIs for order capture/status, load operations, master data sync and accounting across 3 roles: Tenant, Customer and Contract carrier."
url: https://help.qargo.com/us/articles/320484-faq-qargo-api-available-options
locale: us
updated: 2025-06-11
---

# FAQ – Qargo API: available options

**_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? {#h_a17e71f0c7}

### Order capture and status / documents (tenant / customer) {#h_91dfc18b8f}

-   **_Create orders_** from an external system (2 workflow options)

    -   The customer (tenant) creates orders

        -   [Qargo TMS API – Tenant: Order](https://api.qargo.com/ca849acf3cb543a1975722a2882b7712/docs#tag/Use-case-Order)
    -   The customer of the Qargo customer creates orders (customer portal)

        -   [Qargo TMS API – Customer specification document](https://api.qargo.com/customer21704fc3a2dc66a58d59414b/docs)

-   **_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) {#h_800150b33a}

[Qargo TMS API – Contract carrier specification document](https://api.qargo.com/dispatch164648e0838e990ed2d2b195/docs)

-   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)

![](https://help.qargo.com/media/79e6ce0f9227-image.png)

### Master data synchronization (tenant only) {#h_38cc88f244}

[Qargo TMS API specification document](https://api.qargo.com/ca849acf3cb543a1975722a2882b7712/docs#tag/Use-case-Master-data-sync)

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) {#h_1908975dd3}

[Qargo TMS API specification document](https://api.qargo.com/ca849acf3cb543a1975722a2882b7712/docs#tag/Use-case-Accounting)

-   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.)

        ![](https://help.qargo.com/media/76c1936058c2-image.png)


## Related articles

- [Integrations – Qargo API – What, why & how](https://help.qargo.com/us/articles/865547-integrations-qargo-api-what-why-how.md)
- [Invoices - Peppol in Qargo](https://help.qargo.com/us/articles/304774-invoices-peppol-in-qargo.md)
- [Invoices: create a standalone credit memo](https://help.qargo.com/us/articles/281430-invoices-create-a-standalone-credit-memo.md)
- [Integrations: what, why and how](https://help.qargo.com/us/articles/348704-integrations-what-why-and-how.md)
- [Getting started with Qargo: what it is, how it works, and key terminology](https://help.qargo.com/us/articles/662415-getting-started-with-qargo-what-it-is-how-it-works-and-key-terminology.md)
