Qargo API / Order API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Qargo API / 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 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.1.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.1.0

API Version

1.2.0

Base URL

https://api.qargo.com

Authentication

OAuth 2.0, HTTP Basic

Resource Areas

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.

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

AdditionalImportBorderProcessEnum

string

GoodOutput-Output

object

28 properties 1 required

ConsignmentCustomsTransitInfoInput

object

9 properties 1 required

BasePaymentTerm

object

1 property 1 required

Location

object

15 properties

ValidationErrorResponse

object

2 properties 2 required

TimeWindow

object

7 properties

Department

object

2 properties

ContainerResource-Output

object

13 properties

ImportDeclarationTypeEnum

string

KuehneNagelExtraFields

object

2 properties

HTTPValidationError

object

1 property

ResourceTypeEnum

string

StopInput-Output

object

15 properties 1 required

ChargeApprovalInput

object

3 properties 1 required

VehicleResource-Output

object

17 properties

PackagedItem-Input

object

Synonym: GoodItem

13 properties

StopOutput-Output

object

19 properties 2 required

ADR-Input

object

14 properties

PackagedItemCommercialInvoiceExtraField

object

1 property

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

OrderOutput-Output

object

29 properties 3 required

ContainerType

object

4 properties

PackagingSize

object

8 properties

ValidationError

object

3 properties 3 required

ImportExportExtraFields

object

3 properties

ADRPackagingType

string

HandlingUnitInput-Input

object

1 property

OrderPricingInput

object

1 property

PalletlineConsignmentExtraFields

object

1 property

PalletlineExtraFields

object

1 property

TransporeonConsignmentExtraFields

object

1 property

Shipment

object

9 properties 1 required

ConsignmentImportExportExtraFieldsInput-Input

object

4 properties

AdditionalTransitBorderProcessEnum

string

LocationWithTerminalOutput-Output

object

15 properties

Document

object

6 properties 4 required

ChargeWithApprovalOutput

object

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

OrderStatus

string

PackagingType

object

5 properties

Entity

object

2 properties

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

ConsignmentOutput-Output

object

17 properties 3 required

Product

object

4 properties

ExportDeclarationTypeEnum

string

ContactType

string

PaymentTermCode

string

BankAccount

object

2 properties

Position

object

2 properties 2 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

OrderExport

object

30 properties 4 required

BarcodeInput

object

2 properties

ValidationErrorDetail

object

4 properties 1 required

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

OrderStatusStopOutput

object

20 properties 2 required

CompanyContactOutput

object

6 properties

StopExtra

object

3 properties

PlanningGroup

object

2 properties

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

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

Qargo Use case / Customer portal API

AE Profile APIs.io

#API / Order

← Back to Q APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Qargo API / Order API

Metadata

Authentication & Security 2

Paths & Operations 8

Schemas 123

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Qargo API / Order API

Metadata

Authentication & Security 2

Paths & Operations 8

Schemas 123

Specification

Source

More from Qargo 12

API Details

Provider

Explore more