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.
Qargo Use case / 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 Use case / Order. 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 150 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.
2 operations2 paths150 schemas2 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 / 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 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Use case / Order 2
Required api role: APIORDER All endpoints related to order creation and status retrieval/subscription. Getting started See this section to get started. Customer portal See Custome…
The contract defines 150 schemas that model the data the API accepts and returns. The most detailed are OrderInput (30 properties), ConsignmentData (29 properties), OrderUpdateData (28 properties), GoodInput-Input (24 properties). Each schema is shown below with its type and property counts.
ServiceLevel
object
3 properties
ContainerScenario
string
UpdateDropCollectEmptyInput
object
2 properties
ConsignmentMatch
object
2 properties
Project44ConsignmentInput
object
2 properties
CompanyMatch
object
2 properties
PalletlineConsignmentInput
object
2 properties
AmazonExtraFields
object
8 properties
ADRInput
object
8 properties
PartialOrderConsignmentMatchTarget
object
1 property
HandlingUnitData
object
3 properties
PalletXpressIeConsignmentInput
object
1 property
ADR-Input
object
14 properties
CustomerField
object
3 properties
BuyerSellerField
object
3 properties
ADRPackagingType
string
Product
object
4 properties
VehicleCategory
object
3 properties
PartialOrderUpdateResponse
object
Response schema for the partial order update webhook. This schema is used to return errors or success messages.
1 property
DropCollectEmptyInput
object
2 properties
PalletwaysConsignmentInput
object
2 properties
OrderUpdateData
object
28 properties
HandlingUnitUpdateData
object
3 properties
OrderStatus
string
PartialOrderConsignmentUpdate
object
5 properties
PlanningGroup
object
2 properties
PartialOrderGoodTraceUpdate
object
3 properties
CentralTransportNetworkConsignmentInput
object
2 properties
ContainerExtraFields
object
15 properties
AdditionalExportBorderProcessEnum
string
TPNConsignmentInput
object
1 property
ExtraField
object
3 properties
SignatureInput
object
3 properties
AdditionalTransitBorderProcessEnum
string
ContainerTypeInput
object
3 properties
Entity
object
2 properties
PackagingType
object
5 properties
GoodData
object
24 properties
ValidationErrorDetail
object
4 properties1 required
GoodMatch
object
1 property
PartialOrderStopMatchInput
object
1 property
StopInput-Input
object
15 properties1 required
PackagedItem-Input
object
Synonym: GoodItem
13 properties
CommercialInvoiceInput
object
1 property
BarcodeInput
object
2 properties
ExportDeclarationTypeEnum
string
PackagedItemCommercialInvoiceExtraField
object
1 property
Incoterm
string
ImportDeclarationTypeEnum
string
OrderMatch
object
3 properties
ValidationError
object
3 properties3 required
ErrorType
string
PartialOrderUpdate
object
5 properties
ConsignmentTransportNetwork
object
3 properties
OrderPricingInput
object
1 property
PackagedItemsImportExportExtraFields
object
7 properties
PalletforceConsignmentExtraFields
object
1 property
OperationEnum
string
OrderImportExportInput
object
5 properties
StopMatch
object
2 properties
PartialOrderConsignment
object
1 property
PackagedItemInput
object
7 properties
ConsignmentData
object
29 properties
ConsignmentEntityUpdate
object
2 properties1 required
Project44OrderInput
object
2 properties
OrderInput
object
30 properties4 required
TimeWindow
object
7 properties
ChepOrderInput
object
1 property
PartialOrderMatchTarget
object
1 property
UpdateOrderPricingInput
object
1 property
GoodProductInput
object
4 properties
PartialOrderGoodMatchTarget
object
1 property
ConsignmentUpdateData
object
23 properties
LocationInput
object
15 properties
DachserExtraFields
object
1 property
TimeWindowInput
object
6 properties
PartialOrderConsignmentMatchInput
object
1 property
ContainerType
object
4 properties
PartialOrderGoodTraceMatchInput
object
1 property
GoodUpdateData
object
21 properties
PartialOrderGoodTrace
object
1 property
PartialOrderGoodTraceMatchTarget
object
1 property
TransitDeclarationTypeEnum
string
UpdateOperation
string
Operation type for partial order structural updates.
ImportConfiguration
object
1 property
StopTypeField
object
3 properties
GoodInput-Input
object
24 properties
OrderImportResponse
object
Response schema for the order import webhook. This schema is used to return errors or success messages.
1 property
ConsignmentCustomsExportInfo
object
8 properties
PartialOrderStopMatchTarget
object
1 property
Department
object
2 properties
PartialOrderGoodMatchInput
object
1 property
ConsignmentImportExportExtraFieldsInput-Input
object
4 properties
HandlingUnitInput-Input
object
1 property
ImportExportInput
object
3 properties
Position
object
2 properties2 required
StopUpdateData
object
11 properties
StopExtra
object
3 properties
GoodEntityUpdate
object
2 properties1 required
OrderEntityUpdate
object
2 properties1 required
BarcodeSource
string
TransitOffice
object
1 property
AdditionalImportBorderProcessEnum
string
UpdateBarcodeInput
object
2 properties
Location
object
15 properties
ADRPhysicalState
string
TransporeonOrderExtraFields
object
2 properties
ManuportOrderInput
object
5 properties
HandlingUnitEntityUpdate
object
2 properties1 required
StopActivityInput
object
2 properties
GoodProductType
object
2 properties
OrderUpdatePayload
object
1 property
ConsignmentCustomsTransitInfoInput
object
9 properties1 required
RawInput
object
3 properties
PalletforceExtraFields
object
5 properties
StopType
string
ImportExportExtraFields
object
3 properties
ContainerOrderInput
object
15 properties
StopActivityConfigInput
object
4 properties
PackagingSize
object
8 properties
FieldMatchInput
object
1 property
CentralTransportNetworkConsignmentExtraFields
object
3 properties
HSCode
object
2 properties
PartialOrderGoodUpdate
object
4 properties
HandlingUnitMatch
object
1 property
StopEntityUpdate
object
2 properties1 required
GoodPackagingSize
object
2 properties
PartialOrderGood
object
1 property
ADRType
string
PalletlineConsignmentExtraFields
object
1 property
StopPosition
object
1 property
ConsignmentCommercialInvoiceExtraField
object
3 properties
TransporeonConsignmentExtraFields
object
1 property
PartialOrderStopUpdate
object
3 properties
PalletlineExtraFields
object
1 property
ValidationErrorResponse
object
2 properties2 required
HSCodeField
object
2 properties
KuehneNagelExtraFields
object
2 properties
ConsignmentInput-Input
object
15 properties2 required
HTTPValidationError
object
1 property
PalletforceConsignmentInput
object
2 properties
PartialOrderStop
object
1 property
ShippeoOrderInput
object
1 property
StopData
object
16 properties
ConsignmentCustomsImportInfo
object
9 properties
PalletTrackConsignmentInput
object
2 properties
GoodPackagingType
object
4 properties
PartialOrderMatchInput
object
2 properties
ErrorStatus
object
2 properties1 required
HazchemConsignmentInput
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Qargo Use case / 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.
