createManifest

This method adds the 'Ready to Manifest' consignments that are due to be despatched today, to a manifest.

You can filter the consignments by carrier, warehouse and transaction type, and, optionally, manifest group.

The manifest is sent to the carrier automatically following creation.

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:

  1. If you have not already done so, open a new project using the WSDL ManifestService.xml.

  2. Create a new request under createManifest,

  3. Enter the authorisation for the request.

  4. Specify the following to filter the consignments that are 'Ready to manifest':

    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. Click Arrow.png 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:createManifest 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/">T123</manifestGroupCode>
      </ser:createManifest>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then a manifest number is returned, as in the example below, and the newly created manifest is emailed to the carrier.

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:createManifestResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <createManifestReturn soapenc:arrayType="soapenc:string[1]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <createManifestReturn xsi:type="soapenc:string">DMM1W29VQ</createManifestReturn>
         </createManifestReturn>
      </ns1:createManifestResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

If you wish to confirm the creation of the manifest, then check the Historic Manifests (refer to findManifests, Generating a Delivery Manifest and Generating a bulk Delivery Manifest).