Qargo API / Resource API

The API / Resource API from Qargo — 8 operation(s) for api / resource.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 18 operations across 8 paths, and defines 64 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.

18 operations 8 paths 64 schemas 3 DELETE8 GET1 PATCH3 POST3 PUT

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

Across 8 paths, the API surfaces 18 operations — 3 DELETE, 8 GET, 1 PATCH, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

API / Resource 18

POST

/v1/resources/resource

Create Resource

Create_resource_v1_resources_resource_post body → 200400401403422429500503

GET

/v1/resources/resource

List Resources

List_resources_v1_resources_resource_get 6 params → 200400401403422429500503

PUT

/v1/resources/resource/{resource_id}

Update Resource

Update_resource_v1_resources_resource__resource_id__put 1 param body → 200400401403422429500503

PATCH

/v1/resources/resource/{resource_id}

Patch Resource

Patch_resource_v1_resources_resource__resource_id__patch 1 param body → 200400401403422429500503

DELETE

/v1/resources/resource/{resource_id}

Archive Resource

Archive_resource_v1_resources_resource__resource_id__delete 1 param → 204400401403422429500503

GET

/v1/resources/resource/{resource_id}

Get Resource

Get_resource_v1_resources_resource__resource_id__get 1 param → 200400401403422429500503

GET

/v1/resources/resource/{resource_id}/unavailability

List Resource Unavailabilities

List_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_get 4 params → 200400401403422429500503

POST

/v1/resources/resource/{resource_id}/unavailability

Create Resource Unavailabilities

Create_resource_unavailabilities_v1_resources_resource__resource_id__unavailability_post 1 param body → 200400401403422429500503

GET

/v1/resources/resource/{resource_id}/unavailability/{id}

Get Resource Unavailability

Get_resource_unavailability_v1_resources_resource__resource_id__unavailability__id__get 2 params → 200400401403422429500503

PUT

/v1/resources/resource/{resource_id}/unavailability/{id}

Update Resource Unavailabilities

Update_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__put 2 params body → 200400401403422429500503

DELETE

/v1/resources/resource/{resource_id}/unavailability/{id}

Delete Resource Unavailabilities

Delete_resource_unavailabilities_v1_resources_resource__resource_id__unavailability__id__delete 2 params → 204400401403422429500503

GET

/v1/resources/resource/{resource_id}/validity

List Resource Validities

List_resource_validities_v1_resources_resource__resource_id__validity_get 4 params → 200400401403422429500503

POST

/v1/resources/resource/{resource_id}/validity

Create Resource Validity Request

Create_resource_validity_request_v1_resources_resource__resource_id__validity_post 1 param body → 200400401403422429500503

GET

/v1/resources/resource/{resource_id}/validity/{id}

Get Resource Validity

Get_resource_validity_v1_resources_resource__resource_id__validity__id__get 2 params → 200400401403422429500503

PUT

/v1/resources/resource/{resource_id}/validity/{id}

Update Resource Validity

Update_resource_validity_v1_resources_resource__resource_id__validity__id__put 2 params body → 200400401403422429500503

DELETE

/v1/resources/resource/{resource_id}/validity/{id}

Delete Resource Validity

Delete_resource_validity_v1_resources_resource__resource_id__validity__id__delete 2 params → 204400401403422429500503

GET

/v1/resources/resource/{resource_id}/validity/{id}/documents

Get Resource Validity Documents

Get_resource_validity_documents_v1_resources_resource__resource_id__validity__id__documents_get 2 params → 200400401403422429500503

GET

/v1/resources/resource_groups

List Resource Groups

List_resource_groups_v1_resources_resource_groups_get 1 param → 200400401403422429500503

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are TruckProperties-Input (16 properties), TrailerResourceOutput (16 properties), VanResourceOutput (16 properties), ChassisResourceOutput (16 properties). Each schema is shown below with its type and property counts.

VanProperties-Output

object

16 properties

ResourceExtraOutput

object

3 properties 3 required

PartialBaseResourceInput

object

11 properties

TractorResourceInput

object

11 properties 1 required

ChassisResourceInput

object

11 properties 1 required

ChassisResourceOutput

object

16 properties 2 required

TractorProperties-Input

object

11 properties

PartialChassisResourceInput

object

12 properties

PartialDriverResourceInput

object

12 properties

ListResourceUnavailabilityOutput

object

2 properties 1 required

ResourceValidityReason

string

ContainerResourceInput

object

11 properties 1 required

ResourceValidityInput

object

8 properties 2 required

VanResourceInput

object

11 properties 1 required

ListResourceGroupOutput

object

2 properties 1 required

BillingEntityReference

object

1 property 1 required

DriverProperties

object

6 properties

Document

object

6 properties 4 required

TrailerProperties-Input

object

13 properties

VanProperties-Input

object

16 properties

TractorResourceOutput

object

16 properties 2 required

ValidationErrorDetail

object

4 properties 1 required

UnavailabilityReason

string

TrailerResourceOutput

object

16 properties 2 required

TruckResourceInput

object

11 properties 1 required

TruckProperties-Output

object

16 properties

ResourceUnavailabilityInput

object

5 properties 2 required

PartialTruckResourceInput

object

12 properties

DriverDocumentTypes

string

PartialTractorResourceInput

object

12 properties

UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__

object

3 properties 3 required

ValidationErrorResponse

object

2 properties 2 required

ListResourceOutput

object

2 properties 1 required

ChassisProperties-Input

object

10 properties

TractorProperties-Output

object

11 properties

ResourceGroupOutput

object

3 properties 1 required

VanResourceOutput

object

16 properties 2 required

BillingEntity

object

6 properties 5 required

VehicleDocumentTypes

string

ResourceGroupReference

object

1 property 1 required

TrailerProperties-Output

object

13 properties

DriverResourceOutput

object

16 properties 2 required

FullTrailerResourceInput

object

11 properties 1 required

ContainerDocumentTypes

string

CompanyReference

object

1 property 1 required

ResourceExtraInput

object

1 property 1 required

TruckResourceOutput

object

16 properties 2 required

ResourceValidityOutput

object

8 properties 3 required

PartialVanResourceInput

object

12 properties

TrailerResourceInput

object

11 properties 1 required

ListResourceValidityOutput

object

2 properties 1 required

FullTrailerResourceOutput

object

16 properties 2 required

DriverResourceInput

object

11 properties 1 required

ContainerResourceOutput

object

16 properties 2 required

ContainerProperties

object

4 properties

TruckProperties-Input

object

16 properties

ValidationError

object

3 properties 3 required

ResourceUnavailabilityOutput

object

6 properties 3 required

HTTPValidationError

object

1 property

PartialTrailerResourceInput

object

12 properties

PartialFullTrailerResourceInput

object

12 properties

ResourceTypeEnum

string

ChassisProperties-Output

object

10 properties

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

← Back to Q APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Qargo API / Resource API

Metadata

Authentication & Security 2

Paths & Operations 18

Schemas 64

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Qargo API / Resource API

Metadata

Authentication & Security 2

Paths & Operations 18

Schemas 64

Specification

Source

More from Qargo 12

API Details

Provider

Explore more