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

The Use case / Visibility API from Qargo — 2 operation(s) for use case / visibility.

Qargo Use case / Visibility 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 / Visibility. 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 66 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 66 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 / Visibility 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 / Visibility 2
POST
https://
Accounting Visibility Event
Accounting_visibility_eventhttps____accounting_visibility_event_receiving_payload__post body → 200400401403422429500503
POST
https://
Operational Visibility Event
operational_visibility_event_webhook_post body → 200400401403422429500503

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are VisibilityGood (33 properties), PackagedItemOutput-Input (14 properties), ADR-Input (14 properties), VisibilityStop (11 properties). Each schema is shown below with its type and property counts.

TripUpdate
object
Send update event on trip status transitions.
3 properties 2 required
OperationalVisibilityUpdate
object
3 properties 1 required
VisibilityOrderReference
object
1 property 1 required
VisibilityStopStatus
string
ADR-Input
object
14 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
HSCode
object
2 properties
EmbeddedDocument
object
3 properties 3 required
VisibilityConsignment
object
2 properties 1 required
VisibilityQuantityByType
object
2 properties
VisibilityLocation
object
8 properties 1 required
OrderImportUpdate
object
4 properties 2 required
VisibilityOrderStatus
string
OrderUpdateType
string
SalesCreditNoteStatusUpdate
object
3 properties 3 required
ValidationErrorDetail
object
4 properties 1 required
PackagedItemsImportExportExtraFields
object
7 properties
AccountingVisibilityUpdate
object
2 properties 2 required
VisibilityGood
object
33 properties 1 required
CreditNoteStatus
string
Status description: - DRAFT: Credit note is in draft state and not yet credited. - PREINVOICED: Credit note is in pre-invoiced state and not yet credited (Purc…
VisibilityStopType
string
VisibilityDocument
object
4 properties 4 required
ValidationErrorResponse
object
2 properties 2 required
ADRType
string
ExtraField
object
3 properties
ADRPhysicalState
string
VisibilityConsignmentReference
object
1 property 1 required
HandlingUnitUpdate
object
Send update event when a handling unit is updated in Qargo.
10 properties 4 required
VisibilityOrder
object
8 properties 4 required
Incident
object
4 properties
PositionUpdate
object
Send update event on resource (driver, vehicle, subcontractor) position update. Spec only, under development 🚧",
2 properties 2 required
DocumentUpdate
object
Send update event when a document is uploaded to Qargo.
4 properties 3 required
PurchaseCreditNoteStatusUpdate
object
3 properties 3 required
VisibilityEvent
object
2 properties 2 required
PackagingType
object
5 properties
PurchaseInvoiceStatusUpdate
object
3 properties 3 required
EtaUpdate
object
Send update event on stop ETA change.
3 properties 2 required
Entity
object
2 properties
VisibilityDocumentType
string
VisibilityTripStatus
string
ResourceType
string
VisibilityCustomer
object
3 properties 1 required
ResourceUpdate
object
Send update event on resource assignment (allocation). Not that by default, we can send updates on every resource assignment change. This can be customised to…
4 properties 2 required
BarcodeOutput
object
2 properties
HandlingUnitOutput-Input
object
2 properties 1 required
StopUpdate
object
Send update event on stop status change, from order perspective.
3 properties 3 required
PackagingSize
object
8 properties
Product
object
4 properties
ValidationError
object
3 properties 3 required
PackagedItemOutput-Input
object
14 properties 1 required
ADRPackagingType
string
SalesInvoiceStatusUpdate
object
3 properties 3 required
HTTPValidationError
object
1 property
VisibilityOrderImportStatus
string
VisibilityHandlingUnitStatus
string
VisibilityStopReference
object
1 property 1 required
BarcodeSource
string
VisibilityTrip
object
4 properties 3 required
VisibilityDimensionByType
object
2 properties
InvoiceStatus
string
Status description: - DRAFT: Invoice is in draft state and not yet invoiced. - PREINVOICED: Invoice is in pre-invoiced state and not yet invoiced (Purchase inv…
VisibilityResource
object
Represents a resource: van, tractor, trailer and container.
6 properties 1 required
OrderUpdate
object
Send update event on order status change.
5 properties 1 required
RemoteDocument
object
1 property 1 required
VisibilityDocumentStatus
string
VisibilityStop
object
11 properties 4 required
Position
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qargo-use-case-visibility-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