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.

Tracking API

Use the Tracking API to retrieve public shipment tracking details through the Standard Tracking SOAP service. Review access, endpoints, request fields, reference types, validation rules, response objects, and faults before implementation.

Standard TrackingSOAPVersion 1.3Nov 2024
Recommended flow: Confirm access setup, use the test endpoint first, build the SOAP request with a supported reference type, then validate the response and fault handling in your client application.

Purpose and security

Who this API is for and how access works.

Target audience

IT teams and developers integrating customer systems with shipment tracking. Basic understanding of SOAP web services is expected.

Purpose

The service exposes tracking and tracing functionality that is also available in the eSchenker frontend.

Security

Use HTTPS. Every request must include an access key obtained through Web Service usage registration and approved by a Schenker administrator.

Authentication placement

The access key is sent as <AccessKey> inside getPublicServiceShipmentDetails, not inside the Booking <applicationArea> pattern.

Endpoint hosts

Tracking uses different service URLs from Booking, Barcode, Freight List, and Waybill.

StageHostWhen to use
Testhttps://eschenker-fat.dbschenker.com/webservice/trackingWebServiceV3Use for implementation and validation before production access.
Productionhttps://eschenker.dbschenker.com/webservice/trackingWebServiceV3Use after access has been approved and the integration is ready for production traffic.

Service definition

SOAP service, operation, and fault contract.

ItemValueNotes
Port typePublicShipmentServiceStandard Tracking public shipment service.
OperationgetPublicShipmentDetailsRetrieves public shipment details.
MessagesgetPublicShipmentDetailsRequest, getPublicShipmentDetailsResponse, getPublicShipmentDetailsFaultRequest, response, and fault are defined separately.
SOAP actionhttp://www.schenker.com/CustomerServices/eBusiness/ShipmentService/v3/getPublicShipmentDetailsUse document/literal SOAP binding.
Implementation note: The Tracking PDF describes the technical interface in full, but not every method, element, or parameter is required for each customer use case. Build against the required request fields first, then add optional fields only when the selected reference type and validation rules require them.

Tracking sample XML request

Operation wrapper: getPublicServiceShipmentDetails

Use this sample as the base request. Replace the access key, request ID, creation timestamp, reference type, and reference number before testing.

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
    <ns3:getPublicServiceShipmentDetails
xmlns:ns2="http://www.schenker.com/SGI/v4_0"
xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentService/v3">
        <AccessKey>30e85cb0-1e41-11e5-befd-005056ad7714</AccessKey>
        <in>
             <ns2:ApplicationArea>
                 <ns2:requestId>NGES-TRACKING-1442553867 </ns2:requestId>
                 <ns2:CreationDateTime>
                        2015-02-19T11:42:33.867+01:00
                </ns2:CreationDateTime>
             </ns2:ApplicationArea>
             <ns2:referenceType>ff</ns2:referenceType>
             <ns2:referenceNumber>01234567891011</ns2:referenceNumber>
        </in>
    </ns3:getPublicServiceShipmentDetails>
</env:Body>
</env:Envelope>

Tracking sample XML response

Operation response: getPublicShipmentDetailsResponse

Use this sample response to understand the returned shipment details, status events, measurements, references, containers, and linked job outline structure.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"/>
  <soap-env:Body xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <tns:getPublicShipmentDetailsResponse xmlns:tns="http://www.schenker.com/CustomerServices/eBusiness/ShipmentService/v2">
      <out>
        <v4:RequestID xmlns:v4="http://www.schenker.com/SGI/v4_0">
          NGES-TRACKING-1438267810315-xRFPbc4hgmAdmbJ2JjhNPt7UqvtZ1HNrdCpwnwRuSY1Qwaocyamkqh3Ny1dXKtgaNjXyqIis8QMgsvpqj2N21dh2TM72jucsdqry
        </v4:RequestID>
        <v4:TimeOfRequest xmlns:v4="http://www.schenker.com/SGI/v4_0">2015-07-30T16:50:10.358+02:00</v4:TimeOfRequest>
        <v4:Shipment TransportMode="1" Index="0" DataSourceID="cis" xmlns:v4="http://www.schenker.com/SGI/v4_0">
          <v4:ShipmentInfo>
            <v4:ShipmentBasicInfo>
              <ns2:UniqueID xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">84090011195736</ns2:UniqueID>
              <ns2:ShipmentNumberExport xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">MKEOE150002609</ns2:ShipmentNumberExport>
              <ns2:ShipmentNumberImport xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">6560500979</ns2:ShipmentNumberImport>
              <ns2:Location type="DEP" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:LocationID isoCountry="US" codeType="UNLOCODE">USLAX</ns2:LocationID>
                <ns2:LocationName>Los Angeles</ns2:LocationName>
              </ns2:Location>
              <ns2:Location type="DES" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:LocationID isoCountry="AU" codeType="UNLOCODE">SGSIN</ns2:LocationID>
                <ns2:LocationName>Singapore</ns2:LocationName>
              </ns2:Location>
              <ns2:Location type="FDEL" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:LocationID codeType="UNLOCODE">SGSIN</ns2:LocationID>
                <ns2:LocationName>SGSIN</ns2:LocationName>
              </ns2:Location>
              <ns2:DateAndTimes type="84" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:Date>2015-07-01Z</ns2:Date>
              </ns2:DateAndTimes>
              <ns2:DateAndTimes type="132" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:Date>2015-08-21Z</ns2:Date>
                <ns2:Time>00:00:00Z</ns2:Time>
              </ns2:DateAndTimes>
              <ns2:DateAndTimes type="133" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:Date>2015-07-19Z</ns2:Date>
                <ns2:Time>00:00:00Z</ns2:Time>
              </ns2:DateAndTimes>
              <ns2:CarrierName xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:Name>SCHENKEROCEAN LTD,WANG KWONG ROAD,3</ns2:Name>
              </ns2:CarrierName>
              <ns2:ConsignmentMeasurements type="Piece" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:MeasureValue unit="">1</ns2:MeasureValue>
              </ns2:ConsignmentMeasurements>
              <ns2:ConsignmentMeasurements type="ABJ" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:MeasureValue unit="CBM">0.333</ns2:MeasureValue>
              </ns2:ConsignmentMeasurements>
              <ns2:ConsignmentMeasurements type="G" xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:MeasureValue unit="KGS">20.575</ns2:MeasureValue>
              </ns2:ConsignmentMeasurements>
              <ns2:StatusEventList xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">
                <ns2:StatusEvent Index="0">
                  <ns2:Status>ETF</ns2:Status>
                  <ns2:Date>2015-08-22-06:00</ns2:Date>
                  <ns2:Time>11:29:51-06:00</ns2:Time>
                  <ns2:OccurredAt>
                    <ns2:LocationID isoCountry="US" codeType="UNLOCODE">CHICAGO, IL</ns2:LocationID>
                    <ns2:LocationName>CHICAGO, IL</ns2:LocationName>
                  </ns2:OccurredAt>
                  <ns2:Created>
                    <ns2:Datetime>2015-07-24T11:29:49.000-05:00</ns2:Datetime>
                  </ns2:Created>
                  <ns2:StatusInfo type="StatusEventText">ETA AT FINAL CY/CFS</ns2:StatusInfo>
                  <ns2:Remark/>
                  <ns2:Milestone>false</ns2:Milestone>
                  <ns2:Valid>true</ns2:Valid>
                </ns2:StatusEvent>
                <ns2:StatusEvent Index="1">
                  <ns2:Status>DEP</ns2:Status>
                  <ns2:Date>2015-07-19-06:00</ns2:Date>
                  <ns2:Time>00:00:00-06:00</ns2:Time>
                  <ns2:OccurredAt>
                    <ns2:LocationID isoCountry="US" codeType="UNLOCODE">LOS ANGELES, CA</ns2:LocationID>
                    <ns2:LocationName>LOS ANGELES, CA</ns2:LocationName>
                  </ns2:OccurredAt>
                  <ns2:Created>
                    <ns2:Datetime>2015-07-27T21:49:19.000-06:00</ns2:Datetime>
                  </ns2:Created>
                  <ns2:StatusInfo type="StatusEventText">DEPARTURE/CONFIRMED ON BOARD</ns2:StatusInfo>
                  <ns2:Remark/>
                  <ns2:Milestone>true</ns2:Milestone>
                  <ns2:Valid>true</ns2:Valid>
                </ns2:StatusEvent>
              </ns2:StatusEventList>
              <ns2:LastEvent xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">DEP</ns2:LastEvent>
              <ns2:EventDateTime xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">2015-07-19T00:00:00.000+02:00</ns2:EventDateTime>
            </v4:ShipmentBasicInfo>
            <v4:MailAddressExport>SERVICE-TT-SEA.MILWAUKEE@SCHENKER.COM</v4:MailAddressExport>
            <v4:M_Number>CHGOE150001391</v4:M_Number>
            <v4:H_Number>USMKE0000001401</v4:H_Number>
            <v4:TermOfDelivery>ex works</v4:TermOfDelivery>
            <v4:MeansOfTransport>NYK ARTEMIS</v4:MeansOfTransport>
            <v4:MeansOfTransport>V83</v4:MeansOfTransport>
            <v4:noOfContainers>1</v4:noOfContainers>
            <v4:Container Index="1">
              <v4:ContainerNumber>APZU 3301162</v4:ContainerNumber>
              <v4:Type>20DC</v4:Type>
              <v4:Volume>27.588 CBM</v4:Volume>
              <v4:Weight>18800.000 KGS</v4:Weight>
            </v4:Container>
            <v4:AdditionalReference index="0">
              <ns2:qualifier xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">RMB</ns2:qualifier>
              <ns2:value xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">NYKS6066746990</ns2:value>
            </v4:AdditionalReference>
            <v4:AdditionalReference index="1">
              <ns2:qualifier xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">BID</ns2:qualifier>
              <ns2:value xmlns:ns2="http://www.schenker.com/SGI/v4_0" xmlns:ns3="http://www.schenker.com/CustomerServices/eBusiness/ShipmentServicePublic/v1">CHI/FRE/C81732</ns2:value>
            </v4:AdditionalReference>
            <v4:ExportBranchName>SI MILWAUKEE</v4:ExportBranchName>
            <v4:MailAddressImport/>
            <v4:TypeOfService>SS</v4:TypeOfService>
            <v4:PlaceOfLoading>Chicago</v4:PlaceOfLoading>
            <v4:LcPlaceOfLoading>USCHI</v4:LcPlaceOfLoading>
            <v4:LinkedJobOutline>
              <v4:DataSourceID>au</v4:DataSourceID>
              <v4:TransportMode>3</v4:TransportMode>
              <v4:JobQualifier>Domestic_AU_NZ</v4:JobQualifier>
              <v4:JobID>15049452</v4:JobID>
              <v4:SttNo>84090011195736</v4:SttNo>
              <v4:ConsignmentID Type="CN">
                <v4:value>6540501074</v4:value>
              </v4:ConsignmentID>
              <v4:Departure>EAGLE FARM</v4:Departure>
              <v4:Destination>WETHERILL PARK</v4:Destination>
              <v4:CreationDate>2015-07-29+10:00</v4:CreationDate>
              <v4:PiecesCount>1</v4:PiecesCount>
              <v4:Weight>20.580</v4:Weight>
              <v4:WeightUnit>kgm</v4:WeightUnit>
              <v4:Volume>0.333</v4:Volume>
              <v4:VolumeUnit>cbm</v4:VolumeUnit>
              <v4:HawblNo>USMKE0000001401</v4:HawblNo>
              <v4:MawblNo>TBA</v4:MawblNo>
            </v4:LinkedJobOutline>
          </v4:ShipmentInfo>
        </v4:Shipment>
      </out>
    </tns:getPublicShipmentDetailsResponse>
  </soap-env:Body>
</soapenv:Envelope>

Tracking request schema

Core request fields for regular tracking requests.

RequestShipmentDetailsPublicRequestType
Field NameData TypeMandatoryCardinalityDescription
<getPublicServiceShipmentDetails>elementyes1..1Root operation wrapper used to retrieve public shipment details.
<AccessKey>xsd:stringyes1..1Access key from Web Service usage registration.
<in>ShipmentDetailsPublicRequestTypeyes1..1Detailed tracking request payload.
<ApplicationArea>ApplicationAreaTypeno0..1Technical request information.
<requestId>xs:stringno0..1Request identification. Should be unique for every request.
<CreationDateTime>DateTimeTypeyes1..1Creation timestamp in ISO 8601 format, for example YYYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm].
<userId>xs:stringdeprecated0..1Deprecated for Tracking requests and expected to be removed in a future version.
<techUserId>xs:stringdeprecated0..1Deprecated for Tracking requests and expected to be removed in a future version.
<password>xs:stringdeprecated0..1Deprecated for Tracking requests and expected to be removed in a future version.
<referenceType>xs:stringyes1..1Reference type. See the reference type table below.
<referenceNumber>xs:stringyes1..1Alphanumeric reference number. Meaning depends on referenceType.
<transportNature>xs:stringconditional0..1Int for Air and Ocean freight. Exp for Land freight. Mandatory for selected reference types.
<shipmentDateFrom>xs:dateconditional0..1Date in YYYY-MM-DD format. Mandatory for selected customer references.
<shipmentDateTo>xs:dateconditional0..1Date in YYYY-MM-DD format. Mandatory for selected customer references.

Reference types and validation rules

Use this table to choose the correct lookup key.

Reference groupValuesValidation rule
Schenker referencesaam Waybill number, ff Schenker Track & Trace number, bm Bill of Lading number, aw Airwaybill number, akb Container numberreferenceType and referenceNumber are mandatory. transportNature is an error for ff, aw, bm, and akb. It is mandatory for aam.
Customer referencesBID, cu, SRS, cg, SRC, CIN, CBR, CRR, DON, EQC, LPN, MRN, PLN, PON, SAP, SHN, SHIPNO, SON, SSCC, VINreferenceType and referenceNumber are mandatory. For customer references except cu and cg, transportNature, shipmentDateFrom, and shipmentDateTo are mandatory.
Shipper and consignee referencescu shipper reference, cg consignee referencetransportNature is mandatory and must be Int or Exp. Date range fields must not be sent.
Rule: In the validation matrix, M means mandatory, M* means transportNature is mandatory and must be Int or Exp, and E means an error occurs if the field is filled.

Tracking response overview

High-value response objects and fields returned by the Tracking service.

ResponseShipmentDetailsPublicViewType
Field NameData TypeMandatoryCardinalityDescription
<out>ShipmentDetailsPublicViewTypeyes1..1Detailed tracking response payload.
<RequestID>xs:stringyes1..1Request identification returned in the response.
<TimeOfRequest>xs:dateTimeyes1..1Time of request in ISO 8601 format.
<Shipment>ShipmentTypeno0..nShipment record. Includes attributes such as TransportMode, JobQualifier, Index, and DataSourceID.
<BackendTimeMillis>xs:intno0..1Back end processing time in milliseconds.
<message>LogMessageTypeno0..nLog message with severity, code, text, optional date time, and optional domain.
<ShipmentInfo>ShipmentExtendedTypeyes1..1Detailed shipment information.
<ShipmentBasicInfo>ShipmentBasicTypeno0..1Core shipment data such as STT or consignment number, locations, partners, dates, measurements, references, status events, last event, and package events for Land shipments.
<Location>LocationTypeno0..nLocation details. Common types include PICK, DEP, DES, and FDEL.
<DateAndTimes>DateTimeSGITypeno0..nShipment date, estimated departure, estimated arrival, and related date or time values.
<StatusEvent>StatusEventTypeno0..nTracking event list. Each event includes an index and event-specific status information.
<Container>ContainerTypeno0..nOcean shipment container information such as container number, size, type, seal, equipment, volume, and weight.
<LinkedJobOutline>ShipmentOutlineno0..nAdditional domestic information for AU/NZ or US scenarios when available.

Fault response

SOAP fault payload returned by Tracking.

FieldTypeDescription
getPublicShipmentDetailsFaulttns:ShipmentExceptionTypeFault element for the Tracking operation.
BDIDxsd:stringOptional business document ID.
faultCodexsd:QNameQualified fault code.
faultStringxsd:stringFault message text.
detailsxsd:stringOptional details for the fault.