Barcode APIs
Use this section to request barcode labels for an existing booking. Start with the sample XML request and response, then validate the required fields using the schema tables.
Tip: The barcode document is returned as Base64 content and must be decoded by the client application.
Barcode sample XML request
Operation: getBookingBarcodeRequest
Use this sample when requesting barcode labels for an existing booking. Replace the access key, request ID, recipient email, format value, 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:getBookingBarcodeRequest>
<in>
<applicationArea>
<accessKey>YOUR_ACCESS_KEY</accessKey>
<requestID>REQ-BARCODE-001</requestID>
<!-- Optional: provide either groupId or groupName when required for your setup -->
<!-- <groupId>123456</groupId> -->
<!-- <groupName>YOUR_GROUP_NAME</groupName> -->
</applicationArea>
<barcodeRequest>
<format start_pos="1" separated="false">PDF</format>
<barcodeRequestEmail>
<email>recipient@example.com</email>
</barcodeRequestEmail>
<bookingId>1234567890123</bookingId>
</barcodeRequest>
</in>
</v1:getBookingBarcodeRequest>
</soapenv:Body>
</soapenv:Envelope>Barcode sample XML response
Operation: getBookingBarcodeResponse
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:getBookingBarcodeResponse>
<out>
<applicationArea>
<requestID>REQ-BARCODE-001</requestID>
</applicationArea>
<document>BASE64_ENCODED_BARCODE_DOCUMENT</document>
</out>
</v1:getBookingBarcodeResponse>
</soapenv:Body>
</soapenv:Envelope>getBookingBarcodeRequest
SOAP request schema for Barcode APIs.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<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. |
<barcodeRequest> |
barcodeRequestType | yes | 1..1 | Defines which barcodes are requested. |
<format> |
no | |||
start_pos="?" |
positiveInt | yes, if barcodeRequest is provided | 1..1 | Defines the starting position quadrant |
separated="?" |
boolean | yes, if barcodeRequest is provided | 1..1 | Defines if the label is printed on separate pages. |
?</format> |
enumeration | yes, if barcodeRequest is provided | 1..1 | Defines the label format. |
<barcodeRequestEmail> |
barcodeRequestEmailType | no | 0..1 | Option to send the barcode labels to defined email addresses. |
<email>?</email> |
string(250) | yes, if barcodeRequestEmail is provided | 1..25 | Defines the list of email addresses. |
<bookingId>?</bookingId> |
string(13) | yes | 1..1 | Defines the booking id. |
getBookingBarcodeResponse
SOAP response schema for Barcode APIs.
| Field Name | Data Type | Mandatory | Cardinality | Description |
|---|---|---|---|---|
<applicationArea> |
applicationAreaType | yes | 1..1 | |
<requestID>?</requestID> |
string(500) | no | 0..1 | Defines the request id which if it was provided in the request message. |
<document>?</document> |
string(13) | yes | 1..1 | Defines the barcode document in base 64 binary format. |