deallocate

This method de-allocates one or more existing, allocated consignments.

Note

It is assumed that you have worked through Creating your first Request to a Service and are familiar with the Booking Codes and the Allocation Filter.

How to submit a request

Proceed as follows:

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

  2. Create a new request under deallocate,

  3. Enter the authorisation for the request.

  4. Specify the code(s) of the existing consignment(s).

  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:deallocate soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <consignmentCodes xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ser:ArrayOf_soapenc_string" soapenc:arrayType="soapenc:string[]">
            <item>DMC4BY1TZCWS</item>
            <item>DMC4BY1TYSUU</item>
         </consignmentCodes>
      </ser:deallocate>
   </soapenv:Body>
</soapenv:Envelope>

For an example response, see 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:deallocateResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <deallocateReturn soapenc:arrayType="soapenc:string[2]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <deallocateReturn xsi:type="soapenc:string">DMC4BY1TZCWS</deallocateReturn>
            <deallocateReturn xsi:type="soapenc:string">DMC4BY1TYSUU</deallocateReturn>
         </deallocateReturn>
      </ns1:deallocateResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

If you wish to confirm the de-allocation, then

  1. Log into the Delivery Manager Delta environment via the user account that was used to run the API:

    https://dm-delta.metapack.com/dm/ActionServlet?action=home
  2. Click Home and then select the Unallocated status, followed by Search:

    Unallocated_Status.png
  3. Verify that the required consignments are now de-allocated.