Qargo Use case / Location booking API
Required api role: not applicable (push/push)Purpose: This interface allows an external party to integrate with warehouse management systems and location booking platforms.The location booking uses a push/push model: Qargo pushes a booking dispatch payload to an external endpoint.The third party then updates Qargo with booking status changes using our webhook endpoint:### OperationsEach dispatch payload includes an `operation` field indicating the type of action:| Operation | Description ||-----------|-------------|| `CREATE` | New booking request. The external system should create a time slot reservation. || `UPDATE` | Booking details have changed (e.g. updated time window, different vehicle). || `CANCEL` | The booking is no longer needed and should be released. |### Booking scenariosThe `scenario` field indicates the direction of goods movement at the location:| Scenario | Description ||----------|-------------|| `INBOUND` | Goods are being delivered to the location (e.g. warehouse receiving). || `OUTBOUND` | Goods are being picked up from the location (e.g. warehouse shipping). || `INBOUND_OUTBOUND` | Both pickup and delivery happen at the same location in a single booking. |### Status lifecycleThe external system updates the booking status via the [booking update webhook](/docs/use-case-location-booking/location-booking-update-webhook):| Status | Description ||--------|-------------|| `TO_REQUEST` | Initial state - booking has not yet been sent to the external system. || `REQUESTED` | Booking request sent, awaiting confirmation from the location. || `BOOKED` | Time slot confirmed by the location. || `CANCELLED` | Booking was cancelled. |### Payload structureThe dispatch payload contains:- **Trip information**: trip ID, name, and orders linked to the booking- **Booking details**: booking ID, booking name, location address, and relevant stops- **Resources**: vehicle, trailer, and resource allocations assigned to the tripThe destination of the dispatch can be a RESTful interface or file-based protocol like SFTP.### Update payloadThe [booking update webhook](/docs/use-case-location-booking/location-booking-update-webhook) is the inbound channel the external system uses to send booking confirmations, status changes, and execution status updates back to Qargo. Each update carries:- **Booking reference**: either the Qargo booking `id` or a `match` (matching criteria agreed with the external system)- **Status**: new booking status (`REQUESTED`, `BOOKED`, `CANCELLED`)- **Execution statuses**: fine-grained status tracking with event times and remarks- **Question answers**: answers to questions configured on the booking, mapped onto the order
Qargo Use case / Location booking API is one of 22 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Use case / Location booking. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 2 operations across 2 paths, and defines 107 schemas. It is described by OpenAPI 3.2.0, at version 1.2.0.
Requests are made against a single base URL, https://api.qargo.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qargo Use case / Location booking API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow.
It accepts HTTP basic authentication (BasicAuthWebhookCredentials).
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Required api role: not applicable (push/push) Purpose: This interface allows an external party to integrate with warehouse management systems and location booking platforms.
Schemas 107
The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are DispatchOrderOutput (29 properties), GoodOutput-Input (28 properties), CompanyOutput-Input (21 properties), StopOutput-Input (19 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qargo 12
Other APIs Qargo publishes across the network.
This is an independent, third-party profile of Qargo Use case / Location booking API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.