Developer Guide - Connect APIs (SOAP)

On this page you will find an overview of the available Connect APIs, the options offered by each API, and the authentication method used to access the APIs

Connect API schema reference

Use the Connect API schema reference to view detailed SOAP request and response structures for the Booking and Tracking APIs described in this guide.

Open Connect API schema

API: Booking

The Booking API is used to create and manage shipment bookings.

It supports bookings across different transport modes and provides additional operations for booking-related documents and labels.

The Booking API offers the following methods:

Create or Update Booking
Feature: Create or update shipment bookings for supported transport modes.
Supported booking methods:
- Land booking
- Air booking
- Ocean LCL booking
- Ocean FCL booking
Data elements: Booking details, parties and addresses, shipment information, cargo details, pickup details, references, and handling instructions.
Cancel Booking
Feature: Cancel an existing booking using the booking ID.
Data elements: Access key, request ID, user or group information, booking ID.
Barcode Labels
Feature: Request barcode labels for a booking. Barcode labels can also be sent to defined email addresses.
Data elements: Booking ID, label format, start position, separated-page option, email addresses.
Waybill
Feature: Request the waybill for a booking.
Data elements: Booking ID and request information.
Freight List
Feature: Request the freight list for one or more bookings.
Data elements: Booking ID and request information.

API: Tracking

The Tracking API is used to retrieve shipment tracking and tracing information. It allows external systems to request public shipment details by using supported shipment or customer references.

The Tracking API offers one method:

Shipment Details
Feature: Retrieve shipment details, tracking status, and event information for a shipment.
Tracking can be requested using references such as STT number, waybill number, bill of lading number, airwaybill number, container number, booking ID, shipper reference, consignee reference, commercial invoice, movement reference number, purchase order number, and package ID.
Data elements: Access key, request ID, creation date and time, reference type, reference number, transport nature, shipment date range.

Authentication methods

The Connect APIs are SOAP-based web services and use two access controls.

First, users must subscribe to the required API product in the DSV Developer Portal. Once the subscription is approved, the Developer Portal provides a primary and secondary subscription key. These keys are used to verify access to the subscribed API product through the API gateway.

Second, each SOAP request must include the Connect access key required by the Connect web service. This key is used to identify and authorize the Connect user for the requested operation.

For Booking requests, the Connect access key is included in the applicationArea element of the SOAP request.

For Tracking requests, the Connect access key is included as AccessKey in the SOAP request.

The Developer Portal subscription key and the Connect access key are different credentials. The subscription key verifies API gateway access, while the Connect access key authenticates the request in the Connect web service.

Only one Developer Portal subscription key should be used per request. Users can use either the primary key or the secondary key provided for the subscribed API product.

Postman

To facilitate easy development and testing Postman collections have been created.