How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Qargo

Qargo Use case / Visibility API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Qargo Use case / Visibility API is one of 22 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.2.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.2.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), ADR-Input (14 properties), PackagedItemOutput-Input (14 properties), VisibilityStop (11 properties). Each schema is shown below with its type and property counts.

PackagingSize
object
8 properties
VisibilityOrderReference
object
1 property 1 required
ValidationErrorDetail
object
4 properties 1 required
OrderUpdate
object
Send update event on order status change.
5 properties 1 required
VisibilityConsignment
object
2 properties 1 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…
VisibilityHandlingUnitStatus
string
SalesInvoiceStatusUpdate
object
3 properties 3 required
SalesCreditNoteStatusUpdate
object
3 properties 3 required
ADRPackagingType
string
ValidationError
object
3 properties 3 required
VisibilityStopType
string
BarcodeOutput
object
2 properties
VisibilityLocation
object
8 properties 1 required
PackagedItemOutput-Input
object
14 properties 1 required
HSCode
object
2 properties
BarcodeSource
string
VisibilityOrder
object
8 properties 4 required
VisibilityCustomer
object
3 properties 1 required
HandlingUnitOutput-Input
object
2 properties 1 required
EtaUpdate
object
Send update event on stop ETA change.
3 properties 2 required
VisibilityStop
object
11 properties 4 required
VisibilityQuantityByType
object
2 properties
VisibilityStopStatus
string
Incident
object
4 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…
DocumentUpdate
object
Send update event when a document is uploaded to Qargo.
4 properties 3 required
OrderUpdateType
string
OperationalVisibilityUpdate
object
3 properties 1 required
AccountingVisibilityUpdate
object
2 properties 2 required
VisibilityDocument
object
4 properties 4 required
VisibilityConsignmentReference
object
1 property 1 required
HTTPValidationError
object
1 property
VisibilityDocumentType
string
PackagingType
object
5 properties
ExtraField
object
3 properties
StopUpdate
object
Send update event on stop status change, from order perspective.
3 properties 3 required
PackagedItemsImportExportExtraFields
object
7 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
OrderImportUpdate
object
4 properties 2 required
VisibilityOrderStatus
string
ADRPhysicalState
string
ADRType
string
PositionUpdate
object
Send update event on resource (driver, vehicle, subcontractor) position update. Spec only, under development 🚧",
2 properties 2 required
Position
object
2 properties 2 required
RemoteDocument
object
1 property 1 required
HandlingUnitUpdate
object
Send update event when a handling unit is updated in Qargo.
10 properties 4 required
ResourceType
string
PurchaseCreditNoteStatusUpdate
object
3 properties 3 required
VisibilityDimensionByType
object
2 properties
VisibilityEvent
object
2 properties 2 required
VisibilityStopReference
object
1 property 1 required
EmbeddedDocument
object
3 properties 3 required
VisibilityResource
object
Represents a resource: van, tractor, trailer and container.
6 properties 1 required
VisibilityOrderImportStatus
string
Entity
object
2 properties
ValidationErrorResponse
object
2 properties 2 required
VisibilityDocumentStatus
string
Product
object
4 properties
VisibilityTripStatus
string
TripUpdate
object
Send update event on trip status transitions.
3 properties 2 required
PurchaseInvoiceStatusUpdate
object
3 properties 3 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
ADR-Input
object
14 properties
VisibilityTrip
object
4 properties 3 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
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 / Resource 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
#Use case / Visibility
← Back to Q APIs
API Details
ID
qargo:qargo-use-case-visibility-api
Base URL
https://api.qargo.com
Docs
https://api-docs.qargo.com/docs
Provider
Qargo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=qargo-use-case-visibility-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/qargo-use-case-visibility-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Qargo Use case / Visibility API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.