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

The API / Task API from Qargo — 3 operation(s) for api / task.

Qargo API / Task 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 / Task. 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 37 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 37 schemas 2 GET1 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 API / Task 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 — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

API / Task 3
GET
/v1/tasks/available-tasks
List Available Tasks
list_available_tasks_v1_tasks_available_tasks_get → 200400401403429500503
GET
/v1/tasks/task/{id}
Get Task Detail
get_task_detail_v1_tasks_task__id__get 1 param → 200400401403422429500503
POST
/v1/tasks/task/{id}/update-status
Update Task Status
update_task_status_v1_tasks_task__id__update_status_post 1 param body → 200400401403422429500503

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are LineItem (22 properties), CompanySummaryOutput (17 properties), PurchaseInvoice (16 properties), SalesInvoiceOutput (16 properties). Each schema is shown below with its type and property counts.

LineItem
object
Represents a single invoice/credit line item. Note that a single invoice line can be split up in multiple line items if revenue split is enabled.
22 properties 6 required
TaskPayload
object
Task execution input data.
4 properties 3 required
ExchangeRate
object
3 properties 2 required
Document
object
6 properties 4 required
ExternalExecutionMetadata
object
1 property
TaskStatus
string
SalesCreditNoteOutput
object
15 properties 10 required
TaskType
string
PurchaseInvoice
object
16 properties 11 required
CustomerStatus
string
ValidationErrorDetail
object
4 properties 1 required
TaxTypeEnum
string
TaskUpdate
object
Update task status result.
1 property 1 required
AvailableTasks
object
1 property 1 required
BasePaymentTerm
object
1 property 1 required
ValidationErrorResponse
object
2 properties 2 required
LocationOutput
object
13 properties
BaseTaxRate
object
Original base tax rate, before applying customer/transport specific tax rules.
1 property
TaskStatusInput
string
CompanySummaryOutput
object
17 properties 3 required
EInvoicingOutput
object
3 properties
BillingEntity
object
6 properties 5 required
ErrorType
string
api__order__models__charge__AccountOutput
object
1 property
TaskInstanceExecutionMetadata
object
1 property
PurchaseCreditNote
object
15 properties 10 required
TaskFailureStatus
object
2 properties 1 required
TaskDetail
object
6 properties 3 required
SubjectType
string
api__accounting__models__invoice__TaxRate
object
5 properties
ValidationError
object
3 properties 3 required
SalesInvoiceOutput
object
16 properties 11 required
HTTPValidationError
object
1 property
TaxRateType
string
PaymentTermCode
string
AvailableTask
object
Reference to a task available for processing.
4 properties 3 required
TaskUpdateInput
object
Update task status on completion/failure. The failure field can be used to provide more information on failure.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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