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

The API / Trip API from Qargo — 3 operation(s) for api / trip.

Qargo API / Trip 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 / Trip. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

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

3 operations 3 paths 40 schemas 3 GET

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 API / Trip 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 3

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

API / Trip 3
GET
/v1/trips/trip/{trip_id}
Get Trip By Id
get_trip_by_id_v1_trips_trip__trip_id__get 1 param → 200400401403422429500503
GET
/v1/trips/trip/{trip_id}/costs
Get Trip Costs
get_trip_costs_v1_trips_trip__trip_id__costs_get 1 param → 200400401403422429500503
GET
/v1/trips/trip/{trip_id}/documents
Get Trip Documents
get_trip_documents_v1_trips_trip__trip_id__documents_get 1 param → 200400401403422429500503

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are CompanyOutput-Output (21 properties), TripStopOutput (20 properties), VehicleResource-Output (17 properties), DriverResource-Output (16 properties). Each schema is shown below with its type and property counts.

MinimalOrderOutput
object
2 properties 2 required
TerminalMetadata
object
5 properties
ChargeOutput
object
CompanyOutput-Output
object
21 properties 3 required
Document
object
6 properties 4 required
TripStatusOutput
string
LocationWithTerminalOutput-Output
object
15 properties
LocationReference
object
1 property 1 required
CustomerStatus
string
ValidationErrorDetail
object
4 properties 1 required
TaxTypeEnum
string
TripCostsOutput
object
1 property 1 required
BasePaymentTerm
object
1 property 1 required
ValidationErrorResponse
object
2 properties 2 required
LocationOutput
object
13 properties
ResourceAllocation-Output
object
1 property 1 required
OrderReference
object
1 property 1 required
TimeWindow
object
7 properties
AmazonExtraFields
object
8 properties
Gateway
object
1 property 1 required
TripMetrics
object
4 properties
TripStopOutput
object
20 properties 2 required
TripOutput
object
8 properties 5 required
Incident
object
4 properties
DriverResource-Output
object
16 properties
ContainerResource-Output
object
13 properties
CompanyContactOutput
object
6 properties
StopExtra
object
3 properties
PlanningGroup
object
2 properties
GenericResource-Output
object
8 properties
CustomsMetadata
object
1 property
ValidationError
object
3 properties 3 required
CompanyReferenceNumbers
object
5 properties
ContactType
string
HTTPValidationError
object
1 property
StopDepotOutput
object
8 properties
PaymentTermCode
string
BankAccount
object
2 properties
ResourceTypeEnum
string
VehicleResource-Output
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-api-trip-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 System API
Qargo Use case / Accounting API
Qargo Use case / Customer portal API