deleteParcelFromConsignment

This method allows you to remove a parcel from an existing, multi-parcel consignment by specifying its sequence number within the consignment. You can do this at any stage up to and including 'Ready to manifest'.

The weight of the removed parcel is automatically subtracted from the consignment weight. If the consignment has already been allocated, then the costs/charges are recalculated.

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 deleteParcelFromConsignment.
Enter the authorisation for the request.
Specify the code of the existing consignment.
Specify the parcel to be removed by giving its parcelNo (e.g. '1' or '2', etc.).
Set recalculateTaxAndDuty to false.
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:deleteParcelFromConsignment soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <consignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DMC4BY1V4EIV</consignmentCode>
         <parcelNo xsi:type="xsd:int">2</parcelNo>
         <recalculateTaxAndDuty xsi:type="xsd:boolean">false</recalculateTaxAndDuty>
      </ser:deleteParcelFromConsignment>
   </soapenv:Body>
</soapenv:Envelope>

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

Next Steps

If you wish to confirm the removal of the parcel, then find the consignment in the Delivery Manager GUI, and verify the number of parcels under the Details tab.