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


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="" xmlns:xsd="" xmlns:soapenv="" xmlns:ser="urn:DeliveryManager/services">
      <ser:deallocate soapenv:encodingStyle="">
         <consignmentCodes xmlns:soapenc="" xsi:type="ser:ArrayOf_soapenc_string" soapenc:arrayType="soapenc:string[]">

For an example response, see below.

Example Response

<soapenv:Envelope xmlns:soapenv="" xmlns:xsd="" xmlns:xsi="">
      <ns1:deallocateResponse soapenv:encodingStyle="" xmlns:ns1="urn:DeliveryManager/services">
         <deallocateReturn soapenc:arrayType="soapenc:string[2]" xsi:type="soapenc:Array" xmlns:soapenc="">
            <deallocateReturn xsi:type="soapenc:string">DMC4BY1TZCWS</deallocateReturn>
            <deallocateReturn xsi:type="soapenc:string">DMC4BY1TYSUU</deallocateReturn>

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:
  2. Click Home and then select the Unallocated status, followed by Search:

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