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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Qargo

Qargo Use case / Order API

Required api role: `API_ORDER`All endpoints related to order creation and status retrieval/subscription.### Getting startedSee [this section](/docs/section/transport-order-creation-and-status) to get started.### Customer portalSee [Customer portal](/docs/use-case-customer-portal) for the customer version.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

12 operations 12 paths 246 schemas 7 GET5 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 Use case / 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 12

Across 12 paths, the API surfaces 12 operations — 7 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Use case / Order 12

Required api role: APIORDER All endpoints related to order creation and status retrieval/subscription. Getting started See [this section](/docs/section/transport-order-creation-an…

GET
/v1/documents/document/{id}/download
Download Document
download_document_v1_documents_document__id__download_get 2 params → 200400401403422429500503
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
POST
https://
Operational Visibility Event
operational_visibility_event_webhook_post body → 200400401403422429500503
POST
/v1/webhook
Create/Update/Cancel Orders
order-import-webhook body → 200400401403422429500503
POST
/v1/webhook/partial-order-update
Partial Order Update
partial-order-update body → 200400401403422429500503

Schemas 246

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

AdditionalExportBorderProcessEnum
string
PartialOrderGoodTraceMatchInput
object
1 property
HandlingUnitMatch
object
1 property
Incoterm
string
ConsignmentInput-Output
object
15 properties 2 required
ConsignmentImportExportExtraFieldsInput-Output
object
4 properties
ChargesApprovalInput
object
1 property 1 required
GoodProductInput
object
4 properties
HSCode
object
2 properties
ServiceLevel
object
3 properties
PartialOrderGoodMatchInput
object
1 property
OrderMatch
object
3 properties
OrderImportUpdate
object
4 properties 2 required
AdditionalImportBorderProcessEnum
string
GoodOutput-Output
object
28 properties 1 required
ConsignmentCustomsTransitInfoInput
object
9 properties 1 required
StopMatch
object
2 properties
SignatureInput
object
3 properties
HandlingUnitData
object
3 properties
GoodProductType
object
2 properties
VisibilityGood
object
33 properties 1 required
VisibilityDocument
object
4 properties 4 required
BasePaymentTerm
object
1 property 1 required
ConsignmentMatch
object
2 properties
Location
object
15 properties
ValidationErrorResponse
object
2 properties 2 required
TimeWindow
object
7 properties
VisibilityConsignmentReference
object
1 property 1 required
Department
object
2 properties
DocumentUpdate
object
Send update event when a document is uploaded to Qargo.
4 properties 3 required
ContainerResource-Output
object
13 properties
ConsignmentUpdateData
object
23 properties
CommercialInvoiceInput
object
1 property
VisibilityCustomer
object
3 properties 1 required
ImportDeclarationTypeEnum
string
CustomerField
object
3 properties
ResourceUpdate
object
Send update event on resource assignment (allocation). Not that by default, we can send updates on every resource assignment change. This can be customised to…
4 properties 2 required
Project44OrderInput
object
2 properties
KuehneNagelExtraFields
object
2 properties
PartialOrderStopMatchTarget
object
1 property
UpdateDropCollectEmptyInput
object
2 properties
HTTPValidationError
object
1 property
VisibilityHandlingUnitStatus
string
VisibilityTrip
object
4 properties 3 required
StopActivityConfigInput
object
4 properties
PalletlineConsignmentInput
object
2 properties
PartialOrderGood
object
1 property
PalletTrackConsignmentInput
object
2 properties
ResourceTypeEnum
string
StopInput-Output
object
15 properties 1 required
GoodData
object
24 properties
VehicleResource-Output
object
17 properties
VisibilityStop
object
11 properties 4 required
RemoteDocument
object
1 property 1 required
TripUpdate
object
Send update event on trip status transitions.
3 properties 2 required
ChargeApprovalInput
object
3 properties 1 required
CentralTransportNetworkConsignmentInput
object
2 properties
PartialOrderConsignmentUpdate
object
5 properties
PackagedItem-Input
object
Synonym: GoodItem
13 properties
StopOutput-Output
object
19 properties 2 required
PartialOrderUpdateResponse
object
Response schema for the partial order update webhook. This schema is used to return errors or success messages.
1 property
ADR-Input
object
14 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
EmbeddedDocument
object
3 properties 3 required
OrderUpdateType
string
StopEntityUpdate
object
2 properties 1 required
OrderImportExportInput
object
5 properties
TransporeonOrderExtraFields
object
2 properties
TaxTypeEnum
string
UpdateOperation
string
Operation type for partial order structural updates.
ConsignmentEntityUpdate
object
2 properties 1 required
ContainerScenario
string
OrderImport
object
5 properties 3 required
PackagedItem-Output
object
Synonym: GoodItem
13 properties
GoodInput-Input
object
24 properties
ImportConfiguration
object
1 property
ConsignmentCustomsTransitInfoOutput
object
9 properties 2 required
ADRPhysicalState
string
PalletforceConsignmentExtraFields
object
1 property
UpdateOrderPricingInput
object
1 property
OrderInput
object
30 properties 4 required
HSCodeField
object
2 properties
DriverResource-Output
object
16 properties
ChepOrderInput
object
1 property
ADRInput
object
8 properties
ConsignmentTransportNetwork
object
3 properties
VisibilityDocumentType
string
OrderOutput-Output
object
29 properties 3 required
ContainerType
object
4 properties
StopUpdate
object
Send update event on stop status change, from order perspective.
3 properties 3 required
PartialOrderConsignment
object
1 property
PackagingSize
object
8 properties
ValidationError
object
3 properties 3 required
ImportExportExtraFields
object
3 properties
PartialOrderGoodTrace
object
1 property
StopType
string
PackagedItemOutput-Input
object
14 properties 1 required
ADRPackagingType
string
VisibilityOrderImportStatus
string
ManuportOrderInput
object
5 properties
GoodEntityUpdate
object
2 properties 1 required
OrderUpdatePayload
object
1 property
HandlingUnitInput-Input
object
1 property
OrderPricingInput
object
1 property
VisibilityResource
object
Represents a resource: van, tractor, trailer and container.
6 properties 1 required
OrderUpdate
object
Send update event on order status change.
5 properties 1 required
PalletlineConsignmentExtraFields
object
1 property
PalletlineExtraFields
object
1 property
TransporeonConsignmentExtraFields
object
1 property
PartialOrderGoodMatchTarget
object
1 property
Shipment
object
9 properties 1 required
CompanyMatch
object
2 properties
ErrorStatus
object
2 properties 1 required
VisibilityOrderReference
object
1 property 1 required
ConsignmentImportExportExtraFieldsInput-Input
object
4 properties
AdditionalTransitBorderProcessEnum
string
PartialOrderMatchInput
object
2 properties
VisibilityStopStatus
string
LocationWithTerminalOutput-Output
object
15 properties
Document
object
6 properties 4 required
ChargeWithApprovalOutput
object
ContainerOrderInput
object
15 properties
VisibilityQuantityByType
object
2 properties
VisibilityLocation
object
8 properties 1 required
CustomerStatus
string
StopData
object
16 properties
PackagedItemsImportExportExtraFields
object
7 properties
PartialOrderGoodUpdate
object
4 properties
BuyerSellerField
object
3 properties
StopTypeField
object
3 properties
OrderMetrics
object
3 properties
OrderImportResponse
object
Response schema for the order import webhook. This schema is used to return errors or success messages.
1 property
StopPosition
object
1 property
ExtraField
object
3 properties
HandlingUnitOutput-Output
object
2 properties 1 required
DachserExtraFields
object
1 property
ImportExportInput
object
3 properties
VehicleCategory
object
3 properties
TransitOffice
object
1 property
PalletforceExtraFields
object
5 properties
ConsignmentCustomsExportInfo
object
8 properties
RawInput
object
3 properties
ErrorType
string
ConsignmentBuyerSellerOutput-Output
object
2 properties
StopUpdateData
object
11 properties
PalletforceConsignmentInput
object
2 properties
ConsignmentData
object
29 properties
FieldMatchInput
object
1 property
PositionUpdate
object
Send update event on resource (driver, vehicle, subcontractor) position update. Spec only, under development 🚧",
2 properties 2 required
HandlingUnitUpdate
object
Send update event when a handling unit is updated in Qargo.
10 properties 4 required
OrderStatus
string
PackagingType
object
5 properties
EtaUpdate
object
Send update event on stop ETA change.
3 properties 2 required
Entity
object
2 properties
PalletXpressIeConsignmentInput
object
1 property
VisibilityTripStatus
string
GenericResource-Output
object
8 properties
OrderWithStatus
object
34 properties 3 required
CustomsMetadata
object
1 property
ADR-Output
object
14 properties
PackagedItemOutput-Output
object
14 properties 1 required
GoodPackagingType
object
4 properties
GoodPackagingSize
object
2 properties
PartialOrderStopUpdate
object
3 properties
BarcodeOutput
object
2 properties
HandlingUnitOutput-Input
object
2 properties 1 required
ConsignmentOutput-Output
object
17 properties 3 required
Product
object
4 properties
TPNConsignmentInput
object
1 property
ExportDeclarationTypeEnum
string
PartialOrderGoodTraceUpdate
object
3 properties
ContactType
string
OrderEntityUpdate
object
2 properties 1 required
VisibilityStopReference
object
1 property 1 required
PartialOrderUpdate
object
5 properties
PaymentTermCode
string
VisibilityDimensionByType
object
2 properties
BankAccount
object
2 properties
VisibilityDocumentStatus
string
Position
object
2 properties 2 required
PackagedItemInput
object
7 properties
OperationalVisibilityUpdate
object
3 properties 1 required
TerminalMetadata
object
5 properties
HandlingUnitUpdateData
object
3 properties
CentralTransportNetworkConsignmentExtraFields
object
3 properties
PartialOrderConsignmentMatchTarget
object
1 property
CompanyOutput-Output
object
21 properties 3 required
StopInput-Input
object
15 properties 1 required
PalletwaysConsignmentInput
object
2 properties
PartialOrderStop
object
1 property
HandlingUnitInput-Output
object
1 property
PartialOrderMatchTarget
object
1 property
SignatureType
string
VisibilityConsignment
object
2 properties 1 required
OrderExport
object
30 properties 4 required
BarcodeInput
object
2 properties
VisibilityOrderStatus
string
ValidationErrorDetail
object
4 properties 1 required
VisibilityStopType
string
TransitDeclarationTypeEnum
string
DropCollectEmptyInput
object
2 properties
LocationOutput
object
13 properties
ADRType
string
ResourceAllocation-Output
object
1 property 1 required
ConsignmentCommercialInvoiceExtraField
object
3 properties
TimeWindowInput
object
6 properties
AmazonExtraFields
object
8 properties
ShippeoOrderInput
object
1 property
Gateway
object
1 property 1 required
PartialOrderGoodTraceMatchTarget
object
1 property
GoodUpdateData
object
21 properties
ConsignmentCustomsImportInfo
object
9 properties
Incident
object
4 properties
OperationEnum
string
VisibilityOrder
object
8 properties 4 required
OrderStatusStopOutput
object
20 properties 2 required
VisibilityEvent
object
2 properties 2 required
CompanyContactOutput
object
6 properties
StopExtra
object
3 properties
LocationInput
object
15 properties
PlanningGroup
object
2 properties
UpdateBarcodeInput
object
2 properties
ResourceType
string
GoodInput-Output
object
24 properties
ChargeApprovalStatusInput
string
BuyerSellerCompanyOutput-Output
object
10 properties 2 required
ContainerExtraFields
object
15 properties
OrderPricingOutput
object
5 properties
Signature
object
4 properties 1 required
ConsignmentImportExportExtraFieldsOutput-Output
object
4 properties
CompanyReferenceNumbers
object
5 properties
StopActivityInput
object
2 properties
PartialOrderStopMatchInput
object
1 property
GoodMatch
object
1 property
HandlingUnitEntityUpdate
object
2 properties 1 required
ContainerTypeInput
object
3 properties
Project44ConsignmentInput
object
2 properties
HazchemConsignmentInput
object
2 properties
BarcodeSource
string
UploadStatus
string
StopDepotOutput
object
8 properties
OrderChargesOutput
object
1 property
OrderUpdateData
object
28 properties
ConsignmentInput-Input
object
15 properties 2 required
PartialOrderConsignmentMatchInput
object
1 property
LocationReference
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-use-case-order-api-openapi.yml Raw ↑

Other APIs Qargo publishes across the network.

Qargo Subcontractor API
AE Profile APIs.io
Qargo Customer API
AE Profile APIs.io
Qargo API / Accounting API
AE Profile APIs.io
Qargo API / Authentication API
AE Profile APIs.io
Qargo API / Company API
AE Profile APIs.io
Qargo API / Document API
AE Profile APIs.io
Qargo API / Order API
AE Profile APIs.io
Qargo API / Resource API
AE Profile APIs.io
Qargo API / Task API
AE Profile APIs.io
Qargo API / Trip API
AE Profile APIs.io
Qargo System API
AE Profile APIs.io
Qargo Use case / Accounting API
AE Profile APIs.io
#Use case / Order
← Back to Q APIs
API Details
ID
qargo:qargo-use-case-order-api
Base URL
https://api.qargo.com
Docs
https://api-docs.qargo.com/docs
Provider
Qargo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network