# Qargo Use case / Document import API **Canonical:** https://apis.io/apis/qargo/qargo-use-case-document-import-api/ **Provider:** Qargo — https://apis.io/providers/qargo/ **Base URL:** https://api.qargo.com **Documentation:** https://api-docs.qargo.com/docs Qargo Use case / Document import API is one of 26 APIs that [Qargo](https://apis.io/providers/qargo/) publishes on the [APIs.io](https://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 section provides an overview of all available methods to import documents into Qargo. ![Document import paths overview](/docs/static/document_import_overview.svg) ### Document import methods There are five ways to get documents into Qargo, grouped by domain: #### Operational #### 1. Generic document import webhook The 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 content See the [generic document import webhook](/docs/use-case-document-import/document-import-webhook) for full details. #### Master Data #### 2. Synchronous API upload Upload 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 webhook Upload 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 webhook Upload 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 webhook Import 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 uploads See 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. ## Machine-readable artifacts (2) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/qargo/refs/heads/main/openapi/qargo-use-case-document-import-api-openapi.yml - **APIReference** — https://api-docs.qargo.com/docs ## Other Qargo APIs (12) - [Qargo Subcontractor API](https://apis.io/apis/qargo/qargo-subcontractor-api/) - [Qargo Customer API](https://apis.io/apis/qargo/qargo-customer-api/) - [Qargo API / Accounting API](https://apis.io/apis/qargo/qargo-api-accounting-api/) - [Qargo API / Authentication API](https://apis.io/apis/qargo/qargo-api-authentication-api/) - [Qargo API / Company API](https://apis.io/apis/qargo/qargo-api-company-api/) - [Qargo API / Document API](https://apis.io/apis/qargo/qargo-api-document-api/) - [Qargo API / Order API](https://apis.io/apis/qargo/qargo-api-order-api/) - [Qargo API / Resource API](https://apis.io/apis/qargo/qargo-api-resource-api/) - [Qargo API / Task API](https://apis.io/apis/qargo/qargo-api-task-api/) - [Qargo API / Trip API](https://apis.io/apis/qargo/qargo-api-trip-api/) - [Qargo System API](https://apis.io/apis/qargo/qargo-system-api/) - [Qargo Use case / Accounting API](https://apis.io/apis/qargo/qargo-use-case-accounting-api/) ## Tags Use case / Document import --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/qargo/qargo-use-case-document-import-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/qargo/.