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 API / Order API

The API / Order API from Qargo — 8 operation(s) for api / order.

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

Tagged areas include API / Order. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 8 operations across 8 paths, and defines 123 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.

8 operations 8 paths 123 schemas 6 GET2 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 API / Order 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 8

Across 8 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

API / Order 8
POST
/v1/orders/order/upload
Import Order
import_order_v1_orders_order_upload_post body → 200400401403422429500503
GET
/v1/orders/order/upload/{upload_id}
Get Order Import Status
get_order_import_status_v1_orders_order_upload__upload_id__get 1 param → 200400401403422429500503
GET
/v1/orders/order/{order_id}
Get Order Details
get_order_details_v1_orders_order__order_id__get 1 param → 200400401403422429500503
GET
/v1/orders/order/{order_id}/charges
List Order Charges
List_Order_Charges_v1_orders_order__order_id__charges_get 1 param → 200400401403422429500503
POST
/v1/orders/order/{order_id}/charges/approval
Approve Order Charges
Approve_Order_Charges_v1_orders_order__order_id__charges_approval_post 1 param body → 200400401403422429500503
GET
/v1/orders/order/{order_id}/documents
List Order Documents
list_order_documents_v1_orders_order__order_id__documents_get 1 param → 200400401403422429500503
GET
/v1/orders/order/{order_id}/export
Order Export
order_export_v1_orders_order__order_id__export_get 1 param → 200400401403422429500503
GET
/v1/orders/order/{order_id}/status
Order Status
order_status_v1_orders_order__order_id__status_get 1 param → 200400401403422429500503

Schemas 123

The contract defines 123 schemas that model the data the API accepts and returns. The most detailed are OrderWithStatus (34 properties), OrderInput (30 properties), OrderExport (30 properties), OrderOutput-Output (29 properties). Each schema is shown below with its type and property counts.

PackagingSize
object
8 properties
GoodInput-Output
object
24 properties
ConsignmentInput-Output
object
15 properties 2 required
ADRPackagingType
string
ConsignmentImportExportExtraFieldsOutput-Output
object
4 properties
DachserExtraFields
object
1 property
DropCollectEmptyInput
object
2 properties
ResourceAllocation-Output
object
1 property 1 required
StopOutput-Output
object
19 properties 2 required
PalletlineExtraFields
object
1 property
StopInput-Output
object
15 properties 1 required
StopDepotOutput
object
8 properties
TaxTypeEnum
string
ChargesApprovalInput
object
1 property 1 required
HTTPValidationError
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
OrderPricingInput
object
1 property
PalletforceExtraFields
object
5 properties
PackagedItem-Input
object
Synonym: GoodItem
13 properties
ServiceLevel
object
3 properties
Department
object
2 properties
ChargeWithApprovalOutput
object
CompanyReferenceNumbers
object
5 properties
ValidationErrorDetail
object
4 properties 1 required
ConsignmentImportExportExtraFieldsInput-Input
object
4 properties
PaymentTermCode
string
OperationEnum
string
ValidationError
object
3 properties 3 required
BarcodeOutput
object
2 properties
StopInput-Input
object
15 properties 1 required
OrderExport
object
30 properties 4 required
Location
object
15 properties
ConsignmentCustomsImportInfo
object
9 properties
ContainerType
object
4 properties
ImportDeclarationTypeEnum
string
OrderImport
object
5 properties 3 required
TransporeonOrderExtraFields
object
2 properties
ConsignmentOutput-Output
object
17 properties 3 required
PackagingType
object
5 properties
LocationReference
object
1 property 1 required
PackagedItemCommercialInvoiceExtraField
object
1 property
DriverResource-Output
object
16 properties
TransporeonConsignmentExtraFields
object
1 property
ConsignmentImportExportExtraFieldsInput-Output
object
4 properties
OrderChargesOutput
object
1 property
ValidationErrorResponse
object
2 properties 2 required
BankAccount
object
2 properties
ADR-Output
object
14 properties
BarcodeInput
object
2 properties
Incoterm
string
RawInput
object
3 properties
KuehneNagelExtraFields
object
2 properties
ConsignmentCustomsTransitInfoOutput
object
9 properties 2 required
BarcodeSource
string
ContainerScenario
string
ContainerExtraFields
object
15 properties
Incident
object
4 properties
HandlingUnitInput-Input
object
1 property
Gateway
object
1 property 1 required
ContactType
string
CentralTransportNetworkConsignmentExtraFields
object
3 properties
ChargeApprovalInput
object
3 properties 1 required
AdditionalExportBorderProcessEnum
string
ExportDeclarationTypeEnum
string
LocationWithTerminalOutput-Output
object
15 properties
CustomsMetadata
object
1 property
PackagedItemOutput-Output
object
14 properties 1 required
OrderWithStatus
object
34 properties 3 required
ImportConfiguration
object
1 property
ConsignmentInput-Input
object
15 properties 2 required
PalletforceConsignmentExtraFields
object
1 property
StopExtra
object
3 properties
BuyerSellerCompanyOutput-Output
object
10 properties 2 required
VehicleCategory
object
3 properties
VehicleResource-Output
object
17 properties
GoodOutput-Output
object
28 properties 1 required
Entity
object
2 properties
AdditionalTransitBorderProcessEnum
string
HandlingUnitInput-Output
object
1 property
TimeWindow
object
7 properties
CompanyContactOutput
object
6 properties
LocationOutput
object
13 properties
OrderPricingOutput
object
5 properties
GoodInput-Input
object
24 properties
OrderInput
object
30 properties 4 required
AmazonExtraFields
object
8 properties
ConsignmentCustomsExportInfo
object
8 properties
ResourceTypeEnum
string
CompanyOutput-Output
object
21 properties 3 required
ChargeApprovalStatusInput
string
HSCode
object
2 properties
Shipment
object
9 properties 1 required
TransitDeclarationTypeEnum
string
ConsignmentTransportNetwork
object
3 properties
TransitOffice
object
1 property
ConsignmentBuyerSellerOutput-Output
object
2 properties
OrderMetrics
object
3 properties
ImportExportExtraFields
object
3 properties
PalletlineConsignmentExtraFields
object
1 property
ConsignmentCommercialInvoiceExtraField
object
3 properties
OrderStatusStopOutput
object
20 properties 2 required
Document
object
6 properties 4 required
HandlingUnitOutput-Output
object
2 properties 1 required
ConsignmentCustomsTransitInfoInput
object
9 properties 1 required
OrderOutput-Output
object
29 properties 3 required
CustomerStatus
string
OrderStatus
string
AdditionalImportBorderProcessEnum
string
GenericResource-Output
object
8 properties
TerminalMetadata
object
5 properties
BasePaymentTerm
object
1 property 1 required
ContainerResource-Output
object
13 properties
UploadStatus
string
Product
object
4 properties
PackagedItem-Output
object
Synonym: GoodItem
13 properties
SignatureType
string
ADR-Input
object
14 properties
PlanningGroup
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-api-order-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 / Resource API
Qargo API / Task API
Qargo API / Trip API
Qargo System API
Qargo Use case / Accounting API
Qargo Use case / Document import API
Where this information came from

This is an independent, third-party profile of Qargo API / Order 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.