Qargo Use case / Document import API
This section provides an overview of all available methods to import documents into Qargo.### Document import methodsThere are five ways to get documents into Qargo, grouped by domain:#### Operational#### 1. Generic document import webhookThe most flexible option for importing documents at the **order level**. Query parameters are fully configurable per integration and are used to pass file metadata and order matching criteria. Only order-level document types are supported.- **Scope**: Order-level- **Auth**: Basic Auth (webhook credentials)- **Query parameters**: Configurable per integration (`filename` is always required)- **Supported content**: Binary files, text, or base64-encoded contentSee the [generic document import webhook](/docs/use-case-document-import/document-import-webhook) for full details.#### Master Data#### 2. Synchronous API uploadUpload documents directly via the REST API. Used for master data synchronisation (e.g. importing reference documents). Suited for integrations that require a synchronous response.- **Scope**: Master data (sync / import)- **Auth**: OAuth2 (API credentials)See the [document upload endpoint](/docs/api-document/upload_document_content_v1_documents_document_upload_content_post) for full details.#### 3. Subcontractor document upload webhookUpload documents linked to a specific **stop** on a subcontracted trip. Uses fixed query parameters for stop identification and document type mapping.- **Scope**: Stop-level (subcontractor trips)- **Auth**: Basic Auth (webhook credentials)- **Query parameters**: `question_path_key`, `stop_id`See the [subcontractor document upload webhook](/docs/use-case-subcontractor-dispatch/subcontractor-document-upload-webhook) for full details and example.#### 4. Fleet document upload webhookUpload documents linked to a specific **stop** or **stop group** on a fleet-dispatched trip. Same pattern as the subcontractor variant.- **Scope**: Stop-level (fleet trips)- **Auth**: Basic Auth (webhook credentials)- **Query parameters**: `question_path_key`, `stop_id`, `stop_group_id`See the [fleet document upload webhook](/docs/use-case-fleet-dispatch/fleet-document-upload-webhook) for full details and example.#### Accounting#### 5. E-invoicing webhookImport structured purchase invoices or credit notes, optionally with file attachments (e.g. invoice PDF, CMR). Supports JSON, XML (UBL/Peppol), and multipart uploads.- **Scope**: Purchase invoices / credit notes- **Auth**: Basic Auth (webhook credentials)- **Formats**: JSON, XML (Peppol UBL), multipart/form-data- **Attachments**: Supported via `attachments` array (base64-encoded) in JSON, or as additional parts in multipart uploadsSee the [e-invoicing webhook](/docs/use-case-e-invoicing/e-invoicing-webhook) for full details, format examples, and attachment handling.### Choosing the right method| Method | Domain | Scope | Auth | Best for ||--------|--------|-------|------|----------|| Generic document import | Operational | Order | Basic Auth | CMR, POD, packing lists — any order-level document || Subcontractor document upload | Operational | Stop | Basic Auth | POD/CMR from subcontractor systems (per stop) || Fleet document upload | Operational | Stop / Stop group | Basic Auth | POD/CMR from fleet apps (per stop or stop group) || Synchronous API upload | Master Data | Master data | OAuth2 | Reference document synchronisation || E-invoicing | Accounting | Invoice / Credit note | Basic Auth | Purchase invoices via Peppol, EDI, or custom format |> **Note:** The generic document import webhook currently supports **order-level document types only**. For stop-level documents, use the subcontractor or fleet document upload webhooks.
Qargo Use case / Document import 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 / Document import. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 1 operation across 1 path, and defines 7 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 / Document import 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 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
This section provides an overview of all available methods to import documents into Qargo.  Document impo…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ValidationErrorDetail (4 properties), ValidationError (3 properties), ValidationErrorResponse (2 properties), ErrorStatus (2 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 / Document import 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.