Connect API documentation

Use the Connect APIs to create bookings, request barcode labels, retrieve freight lists, generate waybills, and retrieve shipment tracking details through SOAP-based integration. Start with General Information to understand setup, access, environments, and WSDL links, then choose the API you want to integrate with and use the sample XML together with the field specifications to build and validate your request.

General Information

Use this page before starting development. It explains who the API documentation is for, what the booking web service does, how customers request access, which environments to use, and where to find the WSDL and registration links.

Connect BookingWeb service descriptionVersion 1.3.3

Target audience

Who should use this integration documentation.

This documentation is intended for IT teams and developers at DSV customers who need to integrate with the Connect web services. It assumes a basic understanding of IT terminology and web services.

Purpose

What the Booking web service is used for.

The Booking web service allows customers to submit booking requests through a standard SOAP API instead of using the Connect web frontend. Separate booking services are available for Air, Land, Ocean FCL, and Ocean LCL.

Successful response

The response is returned in real time and includes the customer request ID together with the generated booking ID.

Error response

If the request cannot be processed, the response includes an error code and a detailed error message that can be used for troubleshooting.

Technical setup and usage registration

How customers request API access and generate the access key.

Customers must register and obtain an access key before using a DSV web service. The access key is a dedicated user token. It authenticates the request and links it to the correct Connect user identity configured for the customer.

For the Booking web service, a user group ID may also be required depending on the customer setup and booking requirements. The Connect portal administrator will confirm whether this is needed.

The mandatory access key and optional user group ID are sent in the <applicationArea> segment of the request message.

Request web service access

  1. Sign in to the Connect portal.
  2. Open the Usage Registration eService.
  3. Select Maintain User – Customer in the left navigation.
  4. Select the required web services.
  5. Accept the Terms and Conditions.
  6. Save the request.

Generate the access key

  1. Sign in to the Connect portal.
  2. Open the Usage Registration eService.
  3. Select Maintain User – Customer.
  4. Click Access Key.
  5. Enter the password for the Connect SIMS ID.
  6. Click OK.
  7. The access key is displayed and also sent by email.

Quality gate process

Testing requirement before production approval.

Customers must first test the Booking web service in the Connect test environment. Production access is approved only after the customer has passed the acceptance testing process.

To coordinate testing, contact the local Connect portal administrator or the Connect support team at support.eschenker@dbschenker.com.

Security

Production endpoint security requirements.

Production services are available through HTTPS endpoints. In most cases, customers do not need to manage certificates manually because the Booking web service uses server certificates issued by a well-known Certificate Authority that should already be trusted by standard client key stores.

Endpoint hosts

Use the test environment first, then production after approval. Booking and Tracking use separate service hosts.

Service / stageHostWhen to use
Booking - Testhttps://eschenker-fat.dbschenker.com/webservice/bookingWebServiceV1_1Use this environment first when implementing and testing the Booking web service client.
Booking - Productionhttps://eschenker.dbschenker.com/webservice/bookingWebServiceV1_1Use this environment after the quality gate has been completed and production access has been approved.
Tracking - Testhttps://eschenker-fat.dbschenker.com/webservice/trackingWebServiceV3Use this environment first when implementing and validating the Tracking API client.
Tracking - Productionhttps://eschenker.dbschenker.com/webservice/trackingWebServiceV3Use this environment after access has been approved and the Tracking integration is ready for production traffic.

Version History

Version changes and affected transport modes.

VersionDateChange SummaryApplies To
1.2Not specifiedinitialGeneral
1.2.1Not specifiedadded ../address/contactPerson/nameLand, Air, Ocean LCL, Ocean FCL
1.2.1Not specifiedadded ../address/contactPerson/phoneLand, Air, Ocean LCL, Ocean FCL
1.2.1Not specifiedadded ../pickupHandlingInstructionsLand
1.2.1Not specifiedadded ../deliveryHandlingInstructionsLand
1.2.1Not specifiedadded ../subitems/transportCategoryLand, Air, Ocean LCL, Ocean FCL
1.2.2Not specifiedupdated Error codes listLand, Air, Ocean LCL, Ocean FCL
1.2.2Not specifiedadded Xpath columnLand, Air, Ocean LCL, Ocean FCL
1.2.2Not specifiedadded ../fireworkClassificationLand, Air, Ocean LCL, Ocean FCL
1.2.2Not specifiedupdated list in ../subitems/labelTypeLand, Air, Ocean LCL, Ocean FCL
1.2.3Not specifiedgeneral updateGeneral
1.2.4Not specifiedadded PL specific shipment optionsLand
1.2.5Not specifiedgeneral updateGeneral
1.2.6Not specifiedadded comment in /shippingName and /technicalNameLand
1.2.6Not specifiedadded ../uitApplicableLand
1.2.7Not specifiedgeneral updateGeneral
1.2.8Not specifiedadded dualUse and exchangeableLoadingDeviceLand
1.2.9Not specifiedadded electronicReturnOfDocumentLand
1.3.0Not specifiedadded hsCodeLand, Air, Ocean LCL, Ocean FCL
1.3.1Not specifiedadded getFreightListRequestGeneral
1.3.2Not specifiedgeneral updateGeneral
1.3.3Not specifiedgeneral updateGeneral