How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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:![dispatch flow](/docs/static/subco_dispatch_flow.svg)Subsequent updates or cancellations will also be sent via this webhook, using the same payload format.The dispatch format has the following structure:![dispatch payload](/docs/static/dispatch_subco_payload.svg)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 22 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.2.0, at version 1.2.0.

Requests are made against a single base URL, https://api.qargo.com.

3 operations 3 paths 104 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 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.

Use case / Subcontractor dispatch 3

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…

POST
/v1/webhook/subco-document-upload
External Document Update With Payload
subcontractor-document-upload-webhook 2 params body → 200400401403422429500503
POST
/v1/webhook/subco-status-update
External Status Update
subcontractor-status-update-webhook body → 200400401403422429500503
POST
https://
Subcontractor Dispatch Payload
subcontractor-dispatch-payload body → 200400401403422429500503

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.

PackagingSize
object
8 properties
ConsignmentMatch
object
2 properties
ADRPackagingType
string
ContainerResource-Input
object
13 properties
DachserExtraFields
object
1 property
StopMatchTarget
object
1 property
PalletlineExtraFields
object
1 property
StopDepotOutput
object
8 properties
OrderMatch
object
3 properties
TaxTypeEnum
string
HTTPValidationError
object
1 property
FieldMatchInput
object
1 property
ExtraField
object
3 properties
PackagedItemsImportExportExtraFields
object
7 properties
ADRPhysicalState
string
ADRType
string
Position
object
2 properties 2 required
Signature
object
4 properties 1 required
StopStatusUpdateEnum
string
ConsignmentOutput-Input
object
17 properties 3 required
PalletforceExtraFields
object
5 properties
ServiceLevel
object
3 properties
Department
object
2 properties
ResourceAllocation-Input
object
1 property 1 required
ErrorStatus
object
2 properties 1 required
CompanyReferenceNumbers
object
5 properties
ValidationErrorDetail
object
4 properties 1 required
PaymentTermCode
string
ValidationError
object
3 properties 3 required
BarcodeOutput
object
2 properties
HandlingUnitOutput-Input
object
2 properties 1 required
BaseStatusUpdate
object
2 properties 2 required
ConsignmentCustomsImportInfo
object
9 properties
TripMatch
object
1 property
ContainerType
object
4 properties
ImportDeclarationTypeEnum
string
TransporeonOrderExtraFields
object
2 properties
DispatchOperation
string
PackagingType
object
5 properties
SubcontractorDispatchOutput
object
6 properties 4 required
LocationReference
object
1 property 1 required
PackagedItemCommercialInvoiceExtraField
object
1 property
StopMatch
object
2 properties
DispatchOrder
object
30 properties 3 required
GenericResource-Input
object
8 properties
SubcontractorDispatch
object
2 properties 2 required
CompanyOutput-Input
object
21 properties 3 required
ConsignmentImportExportExtraFieldsOutput-Input
object
4 properties
TransporeonConsignmentExtraFields
object
1 property
StopType
string
ValidationErrorResponse
object
2 properties 2 required
VehicleResource-Input
object
17 properties
GoodOutput-Input
object
28 properties 1 required
BankAccount
object
2 properties
Incoterm
string
DriverResource-Input
object
16 properties
ErrorType
string
KuehneNagelExtraFields
object
2 properties
ConsignmentCustomsTransitInfoOutput
object
9 properties 2 required
PackagedItemOutput-Input
object
14 properties 1 required
BarcodeSource
string
ContainerScenario
string
Incident
object
4 properties
Gateway
object
1 property 1 required
ContactType
string
LocationWithTerminalOutput-Input
object
15 properties
StopOutput-Input
object
19 properties 2 required
CentralTransportNetworkConsignmentExtraFields
object
3 properties
AdditionalExportBorderProcessEnum
string
SubcontractorDispatchResponse
object
Response schema for the subcontractor dispatch payload. This schema is used to return errors or success messages.
1 property
StopMatchInput
object
4 properties
ExportDeclarationTypeEnum
string
CustomsMetadata
object
1 property
StopStatusUpdate
object
Update a stop from an external source. Can update status and data of a stop. Updates on the data happen based on the defined integrationdatamapping in the inte…
6 properties
PalletforceConsignmentExtraFields
object
1 property
StopExtra
object
3 properties
VehicleCategory
object
3 properties
Entity
object
2 properties
AdditionalTransitBorderProcessEnum
string
TimeWindow
object
7 properties
CompanyContactOutput
object
6 properties
LocationOutput
object
13 properties
OrderPricingOutput
object
5 properties
AmazonExtraFields
object
8 properties
ConsignmentCustomsExportInfo
object
8 properties
ResourceTypeEnum
string
HSCode
object
2 properties
TransitDeclarationTypeEnum
string
ConsignmentTransportNetwork
object
3 properties
TransitOffice
object
1 property
ImportExportExtraFields
object
3 properties
ConsignmentBuyerSellerOutput-Input
object
2 properties
PalletlineConsignmentExtraFields
object
1 property
ConsignmentCommercialInvoiceExtraField
object
3 properties
SubcontractorStatusUpdatePayload
object
1 property 1 required
CustomerStatus
string
BuyerSellerCompanyOutput-Input
object
10 properties 2 required
AdditionalImportBorderProcessEnum
string
BasePaymentTerm
object
1 property 1 required
TerminalMetadata
object
5 properties
Product
object
4 properties
SignatureType
string
ADR-Input
object
14 properties
ContainerExtraFields
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-use-case-subcontractor-dispatch-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 / Document 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
Where this information came from

This is an independent, third-party profile of Qargo Use case / Subcontractor dispatch 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.