Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qargo API / Document API

The API / Document API from Qargo — 2 operation(s) for api / document.

Qargo API / Document API is one of 26 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API / Document. 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 6 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.

2 operations 2 paths 6 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.qargo.com
Authentication
OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 2

Qargo API / Document 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 — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

API / Document 2
GET
/v1/documents/document/{id}/download
Download Document
download_document_v1_documents_document__id__download_get 2 params → 200400401403422429500503
POST
/v1/documents/document/upload_content
Upload Document Content
Upload_document_content_v1_documents_document_upload_content_post body → 201400401403422429500503

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ValidationErrorDetail (4 properties), ValidationError (3 properties), ValidationErrorResponse (2 properties), DocumentUploadResponse (1 property). Each schema is shown below with its type and property counts.

ValidationError
object
3 properties 3 required
Body_Upload_document_content_v1_documents_document_upload_content_post
object
1 property 1 required
HTTPValidationError
object
1 property
ValidationErrorResponse
object
2 properties 2 required
DocumentUploadResponse
object
1 property 1 required
ValidationErrorDetail
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-api-document-api-openapi.yml Raw ↑

Other APIs Qargo publishes across the network.

Qargo Subcontractor API
Qargo Customer API
Qargo API / Accounting API
Qargo API / Authentication API
Qargo API / Company API
Qargo API / Order API
Qargo API / Resource API
Qargo API / Task API
Qargo API / Trip API
Qargo System API
Qargo Use case / Accounting API
Qargo Use case / Customer portal API