Qargo Use case / Customer portal API
Required api role: `CUSTOMER`This is the api equivalent of our customer portal functionality.Customers can use this api to create/update/cancel orders, view charges and receive status updates.### Getting startedSee [this section](/docs/section/transport-order-creation-and-status) to get started.
Qargo Use case / Customer portal 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 / Customer portal. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 10 operations across 10 paths, and defines 162 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.
10 operations
10 paths
162 schemas
7 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qargo Use case / Customer portal 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 10
Across 10 paths, the API surfaces 10 operations — 7 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Use case / Customer portal 10
Required api role: CUSTOMER This is the api equivalent of our customer portal functionality. Customers can use this api to create/update/cancel orders, view charges and receive st…
GET
/v1/documents/document/{id}/download
Download Document
POST
/v1/orders/order/upload
Import Order
GET
/v1/orders/order/upload/{upload_id}
Get Order Import Status
GET
/v1/orders/order/{order_id}
Get Order Details
GET
/v1/orders/order/{order_id}/charges
List Order Charges
POST
/v1/orders/order/{order_id}/charges/approval
Approve Order Charges
GET
/v1/orders/order/{order_id}/documents
List Order Documents
GET
/v1/orders/order/{order_id}/export
Order Export
GET
/v1/orders/order/{order_id}/status
Order Status
POST
https://
Operational Visibility Event
Schemas 162
The contract defines 162 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
Incoterm
string
ConsignmentInput-Output
object
15 properties
2 required
ConsignmentImportExportExtraFieldsInput-Output
object
4 properties
ChargesApprovalInput
object
1 property
1 required
HSCode
object
2 properties
ServiceLevel
object
3 properties
OrderImportUpdate
object
4 properties
2 required
AdditionalImportBorderProcessEnum
string
GoodOutput-Output
object
28 properties
1 required
ConsignmentCustomsTransitInfoInput
object
9 properties
1 required
VisibilityGood
object
33 properties
1 required
VisibilityDocument
object
4 properties
4 required
BasePaymentTerm
object
1 property
1 required
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
VisibilityCustomer
object
3 properties
1 required
ImportDeclarationTypeEnum
string
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
KuehneNagelExtraFields
object
2 properties
HTTPValidationError
object
1 property
VisibilityHandlingUnitStatus
string
VisibilityTrip
object
4 properties
3 required
TripUpdate
object
Send update event on trip status transitions.
3 properties
2 required
ResourceTypeEnum
string
StopInput-Output
object
15 properties
1 required
VisibilityStop
object
11 properties
4 required
VehicleResource-Output
object
17 properties
RemoteDocument
object
1 property
1 required
ChargeApprovalInput
object
3 properties
1 required
PackagedItem-Input
object
Synonym: GoodItem
13 properties
StopOutput-Output
object
19 properties
2 required
ADR-Input
object
14 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
EmbeddedDocument
object
3 properties
3 required
OrderUpdateType
string
TransporeonOrderExtraFields
object
2 properties
TaxTypeEnum
string
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
OrderInput
object
30 properties
4 required
DriverResource-Output
object
16 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
PackagingSize
object
8 properties
ValidationError
object
3 properties
3 required
ImportExportExtraFields
object
3 properties
PackagedItemOutput-Input
object
14 properties
1 required
ADRPackagingType
string
VisibilityOrderImportStatus
string
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
Shipment
object
9 properties
1 required
VisibilityOrderReference
object
1 property
1 required
ConsignmentImportExportExtraFieldsInput-Input
object
4 properties
AdditionalTransitBorderProcessEnum
string
VisibilityStopStatus
string
LocationWithTerminalOutput-Output
object
15 properties
Document
object
6 properties
4 required
ChargeWithApprovalOutput
object
VisibilityQuantityByType
object
2 properties
VisibilityLocation
object
8 properties
1 required
CustomerStatus
string
PackagedItemsImportExportExtraFields
object
7 properties
OrderMetrics
object
3 properties
ExtraField
object
3 properties
HandlingUnitOutput-Output
object
2 properties
1 required
DachserExtraFields
object
1 property
VehicleCategory
object
3 properties
TransitOffice
object
1 property
PalletforceExtraFields
object
5 properties
ConsignmentCustomsExportInfo
object
8 properties
RawInput
object
3 properties
ConsignmentBuyerSellerOutput-Output
object
2 properties
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
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
BarcodeOutput
object
2 properties
HandlingUnitOutput-Input
object
2 properties
1 required
ConsignmentOutput-Output
object
17 properties
3 required
Product
object
4 properties
ExportDeclarationTypeEnum
string
ContactType
string
VisibilityStopReference
object
1 property
1 required
VisibilityDimensionByType
object
2 properties
PaymentTermCode
string
BankAccount
object
2 properties
VisibilityDocumentStatus
string
Position
object
2 properties
2 required
OperationalVisibilityUpdate
object
3 properties
1 required
TerminalMetadata
object
5 properties
CentralTransportNetworkConsignmentExtraFields
object
3 properties
CompanyOutput-Output
object
21 properties
3 required
StopInput-Input
object
15 properties
1 required
HandlingUnitInput-Output
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
AmazonExtraFields
object
8 properties
Gateway
object
1 property
1 required
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
PlanningGroup
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
BarcodeSource
string
UploadStatus
string
StopDepotOutput
object
8 properties
OrderChargesOutput
object
1 property
ConsignmentInput-Input
object
15 properties
2 required
LocationReference
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qargo 12
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
#Use case / Customer portal