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

Qargo Use case / Intermodal [partner] API

Note: this is currently only a specification meant as a preview.Implementation is still pending.

Qargo Use case / Intermodal [partner] 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 / Intermodal [partner]. 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 113 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.

2 operations 2 paths 113 schemas 2 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 / Intermodal [partner] 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 / Intermodal [partner] 2

Note: this is currently only a specification meant as a preview. Implementation is still pending.

POST
/v1/webhook/intermodal-status
Intermodal Booking Status Update Webhook
intermodal-booking-status-webhook body → 200400401403422429500503
POST
https://
Intermodal Booking Payload
Intermodal_booking_payloadhttps____intermodal_booking_receiving_payload__post body → 200400401403422429500503

Schemas 113

The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are OrderOutput-Input (29 properties), GoodOutput-Input (28 properties), CompanyOutput-Input (21 properties), Booking (20 properties). Each schema is shown below with its type and property counts.

AdditionalExportBorderProcessEnum
string
Incoterm
string
IntermodalBookingUpdate
object
9 properties
HSCode
object
2 properties
ServiceLevel
object
3 properties
ShippingLocation
object
16 properties
AdditionalImportBorderProcessEnum
string
TemperatureRequirements
object
2 properties
IntermodalBookingPushPayload
object
3 properties 3 required
BookingExecutionData
object
2 properties
ConsignmentOutput-Input
object
17 properties 3 required
ShippingStop
object
3 properties 1 required
BasePaymentTerm
object
1 property 1 required
TransportType
object
2 properties 1 required
ValidationErrorResponse
object
2 properties 2 required
TimeWindow
object
7 properties
BookingVehicleType
string
Department
object
2 properties
OrderOutput-Input
object
29 properties 3 required
ImportDeclarationTypeEnum
string
StopOutput-Input
object
19 properties 2 required
KuehneNagelExtraFields
object
2 properties
HTTPValidationError
object
1 property
ResourceTypeEnum
string
BookingDimensions
object
9 properties
ADR-Input
object
14 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
IntermodalExecutionStatus
object
4 properties 3 required
TransporeonOrderExtraFields
object
2 properties
TaxTypeEnum
string
BookingMatchTarget
object
1 property
ContainerScenario
string
ConsignmentCustomsTransitInfoOutput
object
9 properties 2 required
ADRPhysicalState
string
PalletforceConsignmentExtraFields
object
1 property
IntermodalBookingPayload
object
3 properties 3 required
BuyerSellerCompanyOutput-Input
object
10 properties 2 required
ConsignmentTransportNetwork
object
3 properties
Plugging
object
3 properties
Customs
object
2 properties
ContainerType
object
4 properties
PackagingSize
object
8 properties
ValidationError
object
3 properties 3 required
ImportExportExtraFields
object
3 properties
PackagedItemOutput-Input
object
14 properties 1 required
ADRPackagingType
string
BookingStatus
string
PalletlineConsignmentExtraFields
object
1 property
IntermodalBookingReferences
object
2 properties
PalletlineExtraFields
object
1 property
TransporeonConsignmentExtraFields
object
1 property
ErrorStatus
object
2 properties 1 required
AdditionalGoodsInformation
object
3 properties
AdditionalTransitBorderProcessEnum
string
Container
object
13 properties
CustomerStatus
string
Booking
object
20 properties 6 required
PackagedItemsImportExportExtraFields
object
7 properties
BookingOperation
string
IntermodalExecutionStatusEnum
string
ExtraField
object
3 properties
DachserExtraFields
object
1 property
IntermodalStatuses
object
3 properties
ConsignmentCustomsExportInfo
object
8 properties
VehicleCategory
object
3 properties
PalletforceExtraFields
object
5 properties
TransitOffice
object
1 property
ErrorType
string
FieldMatchInput
object
1 property
PackagingType
object
5 properties
Vehicle
object
17 properties
IntermodalBookingsPushPayload
object
1 property 1 required
Entity
object
2 properties
CustomsMetadata
object
1 property
BarcodeOutput
object
2 properties
HandlingUnitOutput-Input
object
2 properties 1 required
Product
object
4 properties
ExportDeclarationTypeEnum
string
ContactType
string
PaymentTermCode
string
BankAccount
object
2 properties
BookingMatch
object
2 properties
Position
object
2 properties 2 required
DriverMode
string
LocationWithTerminalOutput-Input
object
15 properties
TerminalMetadata
object
5 properties
ShippingRoute
object
5 properties 2 required
CentralTransportNetworkConsignmentExtraFields
object
3 properties
ConsignmentImportExportExtraFieldsOutput-Input
object
4 properties
SignatureType
string
ValidationErrorDetail
object
4 properties 1 required
Trailer
object
17 properties
IntermodalBookingStatusPayload
object
1 property 1 required
ShippingCompany
object
2 properties
TransitDeclarationTypeEnum
string
LocationOutput
object
13 properties
GoodOutput-Input
object
28 properties 1 required
ADRType
string
ConsignmentBuyerSellerOutput-Input
object
2 properties
ConsignmentCommercialInvoiceExtraField
object
3 properties
AmazonExtraFields
object
8 properties
Gateway
object
1 property 1 required
ConsignmentCustomsImportInfo
object
9 properties
Incident
object
4 properties
CompanyContactOutput
object
6 properties
StopExtra
object
3 properties
CompanyReferenceNumbers
object
5 properties
Signature
object
4 properties 1 required
CompanyOutput-Input
object
21 properties 3 required
OrderPricingOutput
object
5 properties
ContainerExtraFields
object
15 properties
BarcodeSource
string
StopDepotOutput
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-use-case-intermodal-partner-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 / Order API
Qargo API / Resource API
Qargo API / Task API
Qargo API / Trip API
Qargo System API
Qargo Use case / Accounting API