This method allows you to unlink an "inner" (child) consignment from its "outer" (parent) consignment, so that you can then, if required, link it to a different parent. Refer to Cartonisation (parent-child).
Note
An inner consignment can have only one 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:
-
If you have not already done so, open a new project using the WSDL
ConsignmentService.xml
. -
Create a new request under
removeInnerFromOuter
, -
Enter the authorisation for the request.
-
-
The Consignment Code (starting with DMC) of the inner consignment, that is, the
innerConsignmentCode
. -
The number of the parcel in the inner consignment to be unlinked from the outer consignment, that is, the
innerParcelNumber
.
Note
You do not need to specify the outer consignment because this can be uniquely identified from its inner consignment.
-
-
Click to submit the request.
If the input is valid, the inner consignment is unlinked from its outer consignment and
true
is returned, as shown in the example below. -
If you wish to unlink another inner consignment, repeat step 4 but change the information in steps a) and b) as required.
<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>
<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>
If you wish to confirm the unlinking, use one of the following ConsignmentSearchService
methods to find the inner 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 - see following example.
<outerConsignmentCode xsi:type="soapenc:string" xsi:nil="true"/> <outerParcelNumber xsi:type="xsd:int">0</outerParcelNumber>