Qargo Use case / Subcontractor dispatch API
Required api role: not applicable (push/push)Purpose: This interface allows an external party to integrate with 3rd party transport management systems for subcontracting.The subcontractor dispatch uses a push/push model: Qargo pushes a dispatch payload to an external endpoint.The third party then updates Qargo using our webhook endpoint:Subsequent updates or cancellations will also be sent via this webhook, using the same payload format.The dispatch format has the following structure:The destination of this webhook can be a RESTful interface or file base protocol like SFTPThe [status update endpoint](/docs/use-case-subcontractor-dispatch/subcontractor-status-update-webhook) can be used to receive information about the stops back to Qargo.Status update date-time values, including `event_time`, `eta_start`, and `eta_end`, must include a timezone offset such as `Z` or `+02:00`.
Qargo Use case / Subcontractor dispatch API is one of 26 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Use case / Subcontractor dispatch. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 3 operations across 3 paths, and defines 104 schemas. It is described by OpenAPI 3.1.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 / Subcontractor dispatch 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 3
Across 3 paths, the API surfaces 3 operations — 3 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 3rd party transport management systems for subcontracting. The sub…
Schemas 104
The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are DispatchOrder (30 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.