deleteConsignment

This method deletes an unallocated consignment.

Note

It is assumed that you have worked through Creating your first Request to a Service and are familiar with the Properties needed to Call or Create a Consignment.

How to submit a request

Proceed as follows:

If you have not already done so, open a new project using the WSDL ConsignmentService.xml.
Create a new request under deleteConsignment,
Enter the authorisation for the request.
Specify the code of the existing consignment to be deleted.
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:deleteConsignment soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <consignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DMC4BY1V44MW</consignmentCode>
      </ser:deleteConsignment>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then the specified consignment is removed, and true is 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:deleteConsignmentResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <deleteConsignmentReturn xsi:type="xsd:boolean">true</deleteConsignmentReturn>
      </ns1:deleteConsignmentResponse>
   </soapenv:Body>
</soapenv:Envelope>