1. Metapack
  2. Shipping
  3. SOAP Shipping API
  4. Manifest Service

createManifestForFutureDespatch

This method allows you to add 'Ready to Manifest' consignments to a post-dated manifest, and clear the consignments from the current transactional flow.

You might want to do this because you have a large number of orders to go out on a particular day in the future, but you want to leave sufficient time to pack and process them beforehand.

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

The manifest is then sent to the carrier automatically.

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 createManifestForFutureDespatch,

  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. Specify the future despatchDate (mandatory).

  6. Set specificDateOnly to true if only those consignments that are due to be despatched on the specified despatchDate are to be added to the manifest. Otherwise, set it to false.

  7. 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:createManifestForFutureDespatch 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>
         <despatchDate xsi:type="xsd:dateTime">2020-07-27T05:31:00.000Z</despatchDate>
         <specificDateOnly xsi:type="xsd:boolean">false</specificDateOnly>
      </ser:createManifestForFutureDespatch>
   </soapenv:Body>
</soapenv:Envelope>

As shown below, if the input is valid, a manifest number is returned 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:createManifestForFutureDespatchResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <createManifestForFutureDespatchReturn soapenc:arrayType="soapenc:string[1]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <createManifestForFutureDespatchReturn xsi:type="soapenc:string">DMM1W29ZV</createManifestForFutureDespatchReturn>
         </createManifestForFutureDespatchReturn>
      </ns1:createManifestForFutureDespatchResponse>
   </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).

Parameters for Consolidated Clearance - createManifestForFutureDespatch

If you are using Consolidated Clearance, you can update your SOAP documentation and add this new optional parameter as an additional setting for the createManifestForFutureDespatch request.

<additionalSettings xsi:type="ns2:ManifestAdditionalSettingsBean" xmlns:ns2="urn:DeliveryManager/types">
   <consolidatedClearance xsi:type="ns2:ManifestConsolidatedClearanceBean" xmlns:ns2="urn:DeliveryManager/types">
      <numberOfContainers xsi:type="soapenc:integer">2</numberOfContainers>
      <format xsi:type="soapenc:string">PDF</format>
      <resolution xsi:type="soapenc:string">300</resolution>
   </consolidatedClearance>
</additionalSettings>

This is how the parameter sample would appear in context within an example createManifestForFutureDespatch request:

<?xml version="1.0"?>
<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:createManifestForFutureDespatch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
            <carrierCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">YOD02</carrierCode>
            <warehouseCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">WARRIORS_WH_UK</warehouseCode>
            <transactionType xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DELIVERY</transactionType>
            <additionalSettings xsi:type="ns2:ManifestAdditionalSettingsBean" xmlns:ns2="urn:DeliveryManager/types">
                <consolidatedClearance xsi:type="ns2:ManifestConsolidatedClearanceBean" xmlns:ns2="urn:DeliveryManager/types">
                    <numberOfContainers xsi:type="soapenc:integer">2</numberOfContainers>
                    <format xsi:type="soapenc:string">ZPL</format>
                    <resolution xsi:type="soapenc:string">300</resolution>
                </consolidatedClearance>
            </additionalSettings>
            <despatchDate xsi:type="xsd:dateTime">2020-07-27T05:31:00.000Z</despatchDate>
            <specificDateOnly xsi:type="xsd:boolean">false</specificDateOnly>
        </ser:createManifestForFutureDespatch>
    </soapenv:Body>
</soapenv:Envelope>