Qargo Webhooks / Inbound API
Inbound webhooks use **Basic Authentication**, not OAuth2. See [Authentication](/docs/section/authentication) for details on how to authenticate webhook requests.
Qargo Webhooks / Inbound 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 / Inbound. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 13 operations across 13 paths, and defines 219 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.
13 operations
13 paths
219 schemas
13 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qargo Webhooks / Inbound 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 13
Across 13 paths, the API surfaces 13 operations — 13 POST. Each is listed below with its method, path, parameters, and response codes.
Webhooks / Inbound 13
Inbound webhooks use Basic Authentication, not OAuth2. See [Authentication](/docs/section/authentication) for details on how to authenticate webhook requests.
POST
/v1/webhook/billing-document-update
External Billing Document (Invoice/Credit-Note) Update
POST
/v1/webhook/document-import
Generic Document Import
POST
/v1/webhook/fleet-document-upload
External Document Upload From A Fleet Application
POST
/v1/webhook/subco-document-upload
External Document Update With Payload
POST
/v1/webhook/e-invoicing
Send E-Invoices
POST
/v1/webhook/fleet-status-update
External Status Update From A Fleet Application
POST
/v1/webhook/intermodal-status
Intermodal Booking Status Update Webhook
POST
/v1/webhook/location-booking-update
Location Booking Update Webhook
POST
/v1/webhook
Create/Update/Cancel Orders
POST
/v1/webhook/partial-order-update
Partial Order Update
POST
/v1/webhook/subco-status-update
External Status Update
POST
/v1/webhook/tracking-update
Tracking Update
POST
/v1/webhook/trip-import
Import Trip
Schemas 219
The contract defines 219 schemas that model the data the API accepts and returns. The most detailed are OrderInput (30 properties), ConsignmentData (29 properties), OrderUpdateData (28 properties), GoodInput-Input (24 properties). Each schema is shown below with its type and property counts.
PartialOrderGoodTraceMatchInput
object
1 property
HandlingUnitMatch
object
1 property
AdditionalExportBorderProcessEnum
string
Incoterm
string
TachographActivityEnum
string
IntermodalBookingUpdate
object
9 properties
TrackingUpdateTachographData
object
8 properties
1 required
GoodProductInput
object
4 properties
HSCode
object
2 properties
IntermodalStatuses
object
3 properties
ServiceLevel
object
3 properties
PartialOrderGoodMatchInput
object
1 property
OrderMatch
object
3 properties
TrackingUpdatePositionData
object
3 properties
3 required
FixedTimestampType
string
api__order__models__charge__AccountInput
object
1 property
1 required
StopMatch
object
2 properties
ConsignmentCustomsTransitInfoInput
object
9 properties
1 required
AdditionalImportBorderProcessEnum
string
SignatureInput
object
3 properties
HandlingUnitData
object
3 properties
GoodProductType
object
2 properties
TrackingUpdateTemperatureMeasurement
object
2 properties
2 required
EInvoiceAttachment
object
1 property
1 required
ExecutionStatusUpdate
object
1 property
SalesInvoiceMatch
object
1 property
ConsignmentMatch
object
2 properties
Location
object
15 properties
ValidationErrorResponse
object
2 properties
2 required
TimeWindow
object
7 properties
StopStatusUpdateEnum
string
Department
object
2 properties
BillingDocumentMatchTarget
object
1 property
TripImportInput
object
7 properties
1 required
EInvoiceLineItem
object
6 properties
2 required
BillingDocumentMatchInput
object
1 property
1 required
ConsignmentUpdateData
object
23 properties
CommercialInvoiceInput
object
1 property
ImportDeclarationTypeEnum
string
EInvoiceDocumentType
string
CustomerField
object
3 properties
Project44OrderInput
object
2 properties
KuehneNagelExtraFields
object
2 properties
PartialOrderStopMatchTarget
object
1 property
api__accounting__models__invoice__TaxRate
object
5 properties
UpdateDropCollectEmptyInput
object
2 properties
HTTPValidationError
object
1 property
TaxRateType
string
StopActivityConfigInput
object
4 properties
PalletlineConsignmentInput
object
2 properties
PartialOrderGood
object
1 property
PurchaseECreditNoteInput
object
13 properties
9 required
GoodData
object
24 properties
PalletTrackConsignmentInput
object
2 properties
CentralTransportNetworkConsignmentInput
object
2 properties
TrackingUpdateMileageData
object
2 properties
1 required
PartialOrderConsignmentUpdate
object
5 properties
PackagedItem-Input
object
Synonym: GoodItem
13 properties
ExchangeRate
object
3 properties
2 required
PartialOrderUpdateResponse
object
Response schema for the partial order update webhook. This schema is used to return errors or success messages.
1 property
StopMatchTarget
object
1 property
ADR-Input
object
14 properties
PackagedItemCommercialInvoiceExtraField
object
1 property
LocationBookingUpdateResponse
object
Response schema for the location booking update webhook. This schema is used to return errors or success messages.
1 property
StopEntityUpdate
object
2 properties
1 required
OrderImportExportInput
object
5 properties
IntermodalExecutionStatus
object
4 properties
3 required
TransporeonOrderExtraFields
object
2 properties
UpdateOperation
string
Operation type for partial order structural updates.
ConsignmentEntityUpdate
object
2 properties
1 required
ContainerScenario
string
VehicleMatchInput
object
3 properties
BookingMatchTarget
object
1 property
GoodInput-Input
object
24 properties
ImportConfiguration
object
1 property
ADRPhysicalState
string
ContainerMatchInput
object
3 properties
StopGroupStatusUpdate
object
Update a stop group from an external source. Can update status and data of the stops in a stop group. Updates on the data happen based on the defined integrati…
5 properties
1 required
PalletforceConsignmentExtraFields
object
1 property
UpdateOrderPricingInput
object
1 property
OrderInput
object
30 properties
4 required
BaseStatusUpdate
object
2 properties
2 required
HSCodeField
object
2 properties
ChepOrderInput
object
1 property
ADRInput
object
8 properties
ConsignmentTransportNetwork
object
3 properties
TrackingUpdateItem
object
2 properties
1 required
ContainerType
object
4 properties
PartialOrderConsignment
object
1 property
PackagingSize
object
8 properties
ValidationError
object
3 properties
3 required
ImportExportExtraFields
object
3 properties
PartialOrderGoodTrace
object
1 property
StopType
string
TrackingUpdateData
object
6 properties
ADRPackagingType
string
TrackingUpdatePayload
object
1 property
EInvoiceDocumentAttachment
object
4 properties
4 required
FleetStatusUpdatePayload
object
1 property
1 required
ManuportOrderInput
object
5 properties
GoodEntityUpdate
object
2 properties
1 required
OrderUpdatePayload
object
1 property
BookingStatus
string
HandlingUnitInput-Input
object
1 property
OrderPricingInput
object
1 property
SalesInvoiceUpdate
object
3 properties
BookingExecutionStatus
object
4 properties
3 required
PalletlineConsignmentExtraFields
object
1 property
IntermodalBookingReferences
object
2 properties
PalletlineExtraFields
object
1 property
PartialOrderGoodMatchTarget
object
1 property
TransporeonConsignmentExtraFields
object
1 property
CompanyMatch
object
2 properties
ErrorStatus
object
2 properties
1 required
PurchaseEInvoiceInput
object
14 properties
10 required
TripImportLocation
object
1 property
ConsignmentImportExportExtraFieldsInput-Input
object
4 properties
AdditionalTransitBorderProcessEnum
string
TrackingMatchTarget
object
1 property
PartialOrderMatchInput
object
2 properties
ContainerOrderInput
object
15 properties
TrackingUpdateWeightData
object
2 properties
1 required
StopData
object
16 properties
PackagedItemsImportExportExtraFields
object
7 properties
PartialOrderGoodUpdate
object
4 properties
BuyerSellerField
object
3 properties
IntermodalExecutionStatusEnum
string
StopTypeField
object
3 properties
OrderImportResponse
object
Response schema for the order import webhook. This schema is used to return errors or success messages.
1 property
StopPosition
object
1 property
TrackingUpdateTemperatureData
object
3 properties
1 required
ExtraField
object
3 properties
ImportExportInput
object
3 properties
DachserExtraFields
object
1 property
DriverMatchInput
object
3 properties
VehicleCategory
object
3 properties
ConsignmentCustomsExportInfo
object
8 properties
PalletforceExtraFields
object
5 properties
StopUpdateData
object
11 properties
TransitOffice
object
1 property
ErrorType
string
PalletforceConsignmentInput
object
2 properties
ConsignmentData
object
29 properties
SubcontractorStatusUpdatePayload
object
1 property
1 required
RawInput
object
3 properties
FieldMatchInput
object
1 property
OrderStatus
string
PackagingType
object
5 properties
Entity
object
2 properties
PalletXpressIeConsignmentInput
object
1 property
GoodPackagingType
object
4 properties
GoodPackagingSize
object
2 properties
PartialOrderStopUpdate
object
3 properties
FleetDispatchStatusUpdate
object
3 properties
3 required
StopMatchInput
object
4 properties
TPNConsignmentInput
object
1 property
Product
object
4 properties
ExportDeclarationTypeEnum
string
PartialOrderGoodTraceUpdate
object
3 properties
TripImportResponse
object
1 property
OrderEntityUpdate
object
2 properties
1 required
PartialOrderUpdate
object
5 properties
DocumentImportResponse
object
Response schema for the document import webhook. This schema is used to return errors or success messages.
1 property
BookingMatch
object
2 properties
Position
object
2 properties
2 required
BillingDocumentUpdate
object
1 property
PackagedItemInput
object
7 properties
LocationBookingUpdatePayload
object
1 property
1 required
HandlingUnitUpdateData
object
3 properties
PartialOrderConsignmentMatchTarget
object
1 property
CentralTransportNetworkConsignmentExtraFields
object
3 properties
StopInput-Input
object
15 properties
1 required
TripImportUnassignedStop
object
2 properties
1 required
PalletwaysConsignmentInput
object
2 properties
PartialOrderStop
object
1 property
PartialOrderMatchTarget
object
1 property
TripImportStop
object
8 properties
3 required
BarcodeInput
object
2 properties
ValidationErrorDetail
object
4 properties
1 required
BillingDocumentUpdatePayload
object
1 property
IntermodalBookingStatusPayload
object
1 property
1 required
TransitDeclarationTypeEnum
string
DropCollectEmptyInput
object
2 properties
ADRType
string
LocationBookingUpdate
object
6 properties
EInvoiceCompanyInput
object
4 properties
1 required
TimeWindowInput
object
6 properties
ShippeoOrderInput
object
1 property
PartialOrderGoodTraceMatchTarget
object
1 property
ConsignmentCommercialInvoiceExtraField
object
3 properties
AmazonExtraFields
object
8 properties
GoodUpdateData
object
21 properties
TripMatch
object
1 property
TrackingUpdateResponse
object
Response schema for the tracking update webhook. This schema is used to return errors or success messages.
1 property
ConsignmentCustomsImportInfo
object
9 properties
OperationEnum
string
TripImportStatus
string
SubcontractorMatchInput
object
3 properties
StopStatusUpdate
object
Update a stop from an external source. Can update status and data of a stop. Updates on the data happen based on the defined integrationdatamapping in the inte…
6 properties
StopExtra
object
3 properties
LocationInput
object
15 properties
PlanningGroup
object
2 properties
UpdateBarcodeInput
object
2 properties
TripImportResource
object
1 property
1 required
TrackingUpdateFuelData
object
2 properties
1 required
TrackingResourceMatchInput
object
4 properties
PartialOrderStopMatchInput
object
1 property
ContainerExtraFields
object
15 properties
StopActivityInput
object
2 properties
HandlingUnitEntityUpdate
object
2 properties
1 required
GoodMatch
object
1 property
TrackingMatchInput
object
1 property
HazchemConsignmentInput
object
2 properties
ContainerTypeInput
object
3 properties
Project44ConsignmentInput
object
2 properties
BarcodeSource
string
ConsignmentInput-Input
object
15 properties
2 required
OrderUpdateData
object
28 properties
PartialOrderConsignmentMatchInput
object
1 property
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 / Inbound