findManifests

This method is used to find manifests that were generated previously.

Note

Another way of finding these is to use the Historic Manifests tab (refer to Generating a Delivery Manifest and Generating a bulk Delivery Manifest).

You need to specify the carrier, warehouse and transaction type, and you can also specify a manifest group, and date range.

Note

It is assumed that you have worked through Creating your first Request to a Service, and that, if required, you have already used addConsignmentsToGroup to assign a manifest group to the consignments.

How to submit a request

Proceed as follows:

If you have not already done so, open a new project using the WSDL ManifestService.xml.
Create a new request under findManifests,
Enter the authorisation for the request.
Specify the following search parameters:
1. The carrier code (refer to findCarriers) (mandatory).
2. The warehouse code (refer to Configuring your Default Warehouse) (mandatory).
3. The transaction type (mandatory).
4. The manifest group (refer to Scanning Consignments to a Trailer and addConsignmentsToGroup) (optional).
  
  Note
  
  If you not using manifest groups, and are simply using the default manifestGroupCode, then you should remove this optional field from the API call.
5. The time and date range of the manifests to be returned (optional).
Click to submit the request.

Example Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="urn:DeliveryManager/services">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:findManifests soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <carrierCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">HERMESPOS</carrierCode>
         <warehouseCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING1</warehouseCode>
         <transactionType xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DELIVERY</transactionType>
         <manifestGroupCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">TRUCK10</manifestGroupCode>
         <dateFrom xsi:type="xsd:dateTime">2020-02-02T05:31:00.000Z</dateFrom>
         <dateTo xsi:type="xsd:dateTime">2020-09-21T22:31:00.000Z</dateTo>
      </ser:findManifests>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then the manifests that meet the search criteria are returned, as in the example below.

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <ns1:findManifestsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <findManifestsReturn soapenc:arrayType="ns2:Manifest[1]" xsi:type="soapenc:Array" xmlns:ns2="urn:DeliveryManager/types" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <findManifestsReturn xsi:type="ns2:Manifest">
               <carrierCode xsi:type="soapenc:string">HERMESPOS</carrierCode>
               <consignmentCount xsi:type="xsd:int">2</consignmentCount>
               <createdDateTime xsi:type="xsd:dateTime">2020-07-24T14:05:21.000Z</createdDateTime>
               <manifestCode xsi:type="soapenc:string">DMM1W29ZV</manifestCode>
               <manifestGroupCode xsi:type="soapenc:string">TRUCK10</manifestGroupCode>
               <manifestStatus xsi:type="soapenc:string">Sent</manifestStatus>
               <sentDateTime xsi:type="xsd:dateTime">2020-07-24T14:18:46.000Z</sentDateTime>
            </findManifestsReturn>
         </findManifestsReturn>
      </ns1:findManifestsResponse>
   </soapenv:Body>
</soapenv:Envelope>