Qargo Webhooks / Outbound API
Outbound webhooks are sent by Qargo to your system when certain events occur. Configure the receiving endpoint URL and credentials in the integration settings.
Qargo Webhooks / Outbound API is one of 26 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhooks / Outbound. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 6 operations across 6 paths, and defines 178 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.
6 operations
6 paths
178 schemas
6 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qargo Webhooks / Outbound 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 6
Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.
Webhooks / Outbound 6
Outbound webhooks are sent by Qargo to your system when certain events occur. Configure the receiving endpoint URL and credentials in the integration settings.
POST
https://
Accounting Visibility Event
POST
https://
Operational Visibility Event
POST
https://
Fleet Dispatch Payload
POST
https://
Intermodal Booking Payload
POST
https://
Location Booking Dispatch Payload
POST
https://
Subcontractor Dispatch Payload
Schemas 178
The contract defines 178 schemas that model the data the API accepts and returns. The most detailed are VisibilityGood (33 properties), DispatchOrder (30 properties), DispatchOrderOutput (29 properties), OrderOutput-Input (29 properties). Each schema is shown below with its type and property counts.
AdditionalExportBorderProcessEnum
string
Incoterm
string
HSCode
object
2 properties
ServiceLevel
object
3 properties
OrderImportUpdate
object
4 properties
2 required
ShippingLocation
object
16 properties
DispatchOrder
object
30 properties
3 required
AdditionalImportBorderProcessEnum
string
VisibilityGood
object
33 properties
1 required
TemperatureRequirements
object
2 properties
IntermodalBookingPushPayload
object
3 properties
3 required
FleetDispatchResponse
object
Response schema for the subcontractor dispatch payload. This schema is used to return errors or success messages.
1 property
BookingExecutionData
object
2 properties
ConsignmentOutput-Input
object
17 properties
3 required
ShippingStop
object
3 properties
1 required
BasePaymentTerm
object
1 property
1 required
TransportType
object
2 properties
1 required
ValidationErrorResponse
object
2 properties
2 required
VisibilityDocument
object
4 properties
4 required
FleetDispatchTemplate
object
2 properties
TimeWindow
object
7 properties
VisibilityConsignmentReference
object
1 property
1 required
LocationDispatchOutput
object
2 properties
2 required
VehicleResource-Input
object
17 properties
GenericResource-Input
object
8 properties
BookingVehicleType
string
Department
object
2 properties
DocumentUpdate
object
Send update event when a document is uploaded to Qargo.
4 properties
3 required
LocationBookingPayload
object
7 properties
3 required
OrderOutput-Input
object
29 properties
3 required
PurchaseCreditNoteStatusUpdate
object
3 properties
3 required
PurchaseInvoiceStatusUpdate
object
3 properties
3 required
VisibilityCustomer
object
3 properties
1 required
ImportDeclarationTypeEnum
string
StopOutput-Input
object
19 properties
2 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
KuehneNagelExtraFields
object
2 properties
ContainerResource-Input
object
13 properties
HTTPValidationError
object
1 property
VisibilityHandlingUnitStatus
string
VisibilityTrip
object
4 properties
3 required
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…
TripUpdate
object
Send update event on trip status transitions.
3 properties
2 required
ResourceTypeEnum
string
RemoteDocument
object
1 property
1 required
VisibilityStop
object
11 properties
4 required
StopGroup
object
8 properties
7 required
BookingDimensions
object
9 properties
ADR-Input
object
14 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
StopGroupStop
object
4 properties
1 required
EmbeddedDocument
object
3 properties
3 required
OrderUpdateType
string
IntermodalExecutionStatus
object
4 properties
3 required
DispatchExecution
object
1 property
1 required
TransporeonOrderExtraFields
object
2 properties
TaxTypeEnum
string
ContainerScenario
string
ConsignmentCustomsTransitInfoOutput
object
9 properties
2 required
ADRPhysicalState
string
PalletforceConsignmentExtraFields
object
1 property
IntermodalBookingPayload
object
3 properties
3 required
BuyerSellerCompanyOutput-Input
object
10 properties
2 required
ConsignmentTransportNetwork
object
3 properties
Plugging
object
3 properties
VisibilityDocumentType
string
Customs
object
2 properties
LocationBookingDispatchResponse
object
Response schema for the location booking dispatch payload. This schema is used to return errors or success messages.
1 property
ContainerType
object
4 properties
StopUpdate
object
Send update event on stop status change, from order perspective.
3 properties
3 required
PackagingSize
object
8 properties
ValidationError
object
3 properties
3 required
ImportExportExtraFields
object
3 properties
PackagedItemOutput-Input
object
14 properties
1 required
ADRPackagingType
string
VisibilityOrderImportStatus
string
StopGroupTemplate
object
3 properties
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
PalletlineConsignmentExtraFields
object
1 property
IntermodalBookingReferences
object
2 properties
PalletlineExtraFields
object
1 property
LocationBookingTripSummary
object
2 properties
TransporeonConsignmentExtraFields
object
1 property
ResourceAllocation-Input
object
1 property
1 required
ErrorStatus
object
2 properties
1 required
AdditionalGoodsInformation
object
3 properties
VisibilityOrderReference
object
1 property
1 required
AdditionalTransitBorderProcessEnum
string
VisibilityStopStatus
string
Container
object
13 properties
SalesCreditNoteStatusUpdate
object
3 properties
3 required
VisibilityQuantityByType
object
2 properties
VisibilityLocation
object
8 properties
1 required
CustomerStatus
string
Booking
object
20 properties
6 required
PackagedItemsImportExportExtraFields
object
7 properties
AccountingVisibilityUpdate
object
2 properties
2 required
BookingOperation
string
DispatchResourceAllocation
object
2 properties
1 required
IntermodalExecutionStatusEnum
string
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…
ExtraField
object
3 properties
DachserExtraFields
object
1 property
ConsignmentCustomsExportInfo
object
8 properties
VehicleCategory
object
3 properties
PalletforceExtraFields
object
5 properties
TransitOffice
object
1 property
ErrorType
string
HandlingUnitUpdate
object
Send update event when a handling unit is updated in Qargo.
10 properties
4 required
PositionUpdate
object
Send update event on resource (driver, vehicle, subcontractor) position update. Spec only, under development 🚧",
2 properties
2 required
PackagingType
object
5 properties
Vehicle
object
17 properties
EtaUpdate
object
Send update event on stop ETA change.
3 properties
2 required
Entity
object
2 properties
IntermodalBookingsPushPayload
object
1 property
1 required
VisibilityTripStatus
string
CustomsMetadata
object
1 property
SubcontractorDispatch
object
2 properties
2 required
BarcodeOutput
object
2 properties
DispatchOperation
string
HandlingUnitOutput-Input
object
2 properties
1 required
FleetDispatchOutput
object
7 properties
5 required
Product
object
4 properties
ExportDeclarationTypeEnum
string
ContactType
string
SalesInvoiceStatusUpdate
object
3 properties
3 required
VisibilityStopReference
object
1 property
1 required
DispatchOrderOutput
object
29 properties
3 required
VisibilityDimensionByType
object
2 properties
PaymentTermCode
string
BankAccount
object
2 properties
VisibilityDocumentStatus
string
Position
object
2 properties
2 required
DriverMode
string
OperationalVisibilityUpdate
object
3 properties
1 required
LocationWithTerminalOutput-Input
object
15 properties
TerminalMetadata
object
5 properties
DriverResource-Input
object
16 properties
ShippingRoute
object
5 properties
2 required
CentralTransportNetworkConsignmentExtraFields
object
3 properties
SubcontractorDispatchResponse
object
Response schema for the subcontractor dispatch payload. This schema is used to return errors or success messages.
1 property
ConsignmentImportExportExtraFieldsOutput-Input
object
4 properties
SignatureType
string
VisibilityConsignment
object
2 properties
1 required
VisibilityOrderStatus
string
ValidationErrorDetail
object
4 properties
1 required
Trailer
object
17 properties
ShippingCompany
object
2 properties
VisibilityStopType
string
TransitDeclarationTypeEnum
string
LocationOutput
object
13 properties
GoodOutput-Input
object
28 properties
1 required
ADRType
string
ConsignmentBuyerSellerOutput-Input
object
2 properties
ConsignmentCommercialInvoiceExtraField
object
3 properties
SubcontractorDispatchOutput
object
6 properties
4 required
FleetDispatch
object
2 properties
2 required
AmazonExtraFields
object
8 properties
Gateway
object
1 property
1 required
ConsignmentCustomsImportInfo
object
9 properties
Incident
object
4 properties
VisibilityOrder
object
8 properties
4 required
VisibilityEvent
object
2 properties
2 required
CompanyContactOutput
object
6 properties
LocationScenario
string
StopExtra
object
3 properties
ResourceType
string
CompanyOutput-Input
object
21 properties
3 required
CompanyReferenceNumbers
object
5 properties
Signature
object
4 properties
1 required
OrderPricingOutput
object
5 properties
ContainerExtraFields
object
15 properties
DispatchConsignmentOutput
object
18 properties
3 required
LocationDispatchPayload
object
6 properties
4 required
BarcodeSource
string
StopDepotOutput
object
8 properties
LocationReference
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qargo 12
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
#Webhooks / Outbound