removeInnerFromOuter

This method allows you to unlink an 'inner' consignment from its 'parent', 'outer' consignment, so that you can then, if required, link it to a different 'parent'. Refer to Cartonisation ('Parent' and 'Child').

Note

A 'child', inner consignment can only ever have one 'parent', 'outer' consignment.

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:

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

  2. Create a new request under removeInnerFromOuter,

  3. Enter the authorisation for the request.

  4. Specify the following:

    1. The Consignment Code (starting with DMC) of the 'inner' consignment (i.e. the innerConsignmentCode).

    2. The number of the parcel in the 'inner' consignment to be unlinked from the 'outer' consignment (i.e. the innerParcelNumber).

    Note

    You do not need to specify the 'parent', as this can be uniquely identified from its 'inner, 'child' consignment.

  5. Click Arrow.png to submit the request.

    If the input is valid, then the 'inner' consignment is unlinked from its 'outer' consignment, and true is returned, as in the example below.

  6. If you wish to unlink a further 'child' consignment, repeat from step 4, changing the information at steps a) and b) as required.

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:removeInnerFromOuter soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <innerConsignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DMC4BY1V6XXS</innerConsignmentCode>
         <innerParcelNumber xsi:type="xsd:int">2</innerParcelNumber>
      </ser:removeInnerFromOuter>
   </soapenv:Body>
</soapenv:Envelope>

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:removeInnerFromOuterResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <removeInnerFromOuterReturn xsi:type="xsd:boolean">true</removeInnerFromOuterReturn>
      </ns1:removeInnerFromOuterResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

If you wish to confirm the unlinking, then, use one of the following ConsignmentSearchService methods to find the 'child' consignments: findConsignmentByConsignmentCode, findConsignmentsByCartonId, findConsignmentsByOrderReference, findConsignmentsByCarrierConsignmentCode.

If you look in the parcels array that is returned from any of the methods, you will see that the outerConsignmentCode and outerParcelNumber are now null, e.g.

<outerConsignmentCode xsi:type="soapenc:string" xsi:nil="true"/>
<outerParcelNumber xsi:type="xsd:int">0</outerParcelNumber>