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.

Freight List API

Use this section to retrieve a freight list document for an existing booking. Start with the sample XML request and response, then validate the required fields using the schema table.

Tip: The request is intentionally small. The booking ID and authentication data drive the document retrieval.

Freight List sample XML request

Operation: getFreightListRequest

Use this sample when retrieving a freight list document for an existing booking. Replace the access key, request ID, and booking ID before testing.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.dbschenker.com/booking/v1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:getFreightListRequest>
      <in>
        <applicationArea>
          <accessKey>YOUR_ACCESS_KEY</accessKey>
          <requestID>REQ-FREIGHTLIST-001</requestID>
          <!-- Optional: provide either groupId or groupName when required for your setup -->
          <!-- <groupId>123456</groupId> -->
          <!-- <groupName>YOUR_GROUP_NAME</groupName> -->
        </applicationArea>
        <bookingId>1234567890123</bookingId>
      </in>
    </v1:getFreightListRequest>
  </soapenv:Body>
</soapenv:Envelope>

Freight List sample XML response

Operation: getFreightListResponse

Use this response sample to understand the expected document payload. The document value is returned as Base64 content.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.dbschenker.com/booking/v1">
  <soapenv:Header/>
  <soapenv:Body>
    <v1:getFreightListResponse>
      <out>
        <applicationArea>
          <requestID>REQ-FREIGHTLIST-001</requestID>
        </applicationArea>
        <document>BASE64_ENCODED_FREIGHT_LIST_DOCUMENT</document>
      </out>
    </v1:getFreightListResponse>
  </soapenv:Body>
</soapenv:Envelope>

getFreightListRequest

SOAP request schema for Freight List API.

Request 8 fields
Field NameData TypeMandatoryCardinalityDescription
<applicationArea> applicationAreaType yes 1..1
<accessKey>?</accessKey> string(100) yes 1..1 Defines the access key (user token).
<groupId>?</groupId> unsignedLong no 0..1 Defines the optional user group id.
<requestID>?</requestID> string(500) no 0..1 Defines the request id which will be returned with the response message.
<userId>?</userId> string no 0..1 Defines the user id for which the booking should be done.
<groupName>?</groupName> string no 0..1 Defines the user group name for which the booking should be done.
<uniqueIdBlocker>?</uniqueIdBlocker> string no 0..1 Defines the unique id blocker.
<bookingId>?</bookingId> string(13) yes 1..1 Defines up to 100 booking ids.