For those sellers who wish their workflow to move to 'Printed' after label printing (refer to How do I Print and Manifest separately?), this method allows you to flag an array of 'Printed' consignments as 'Ready to Manifest'. This allows the manifesting processes (e.g. createManifest and createManifestForFutureDespatch) to pick them up.
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
markConsignmentsAsReadyToManifest
, -
Enter the authorisation for the request.
-
Specify the code(s) of the existing consignment(s).
-
Click to submit the 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:markConsignmentsAsReadyToManifest soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<consignmentCodes xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ser:ArrayOf_soapenc_string" soapenc:arrayType="soapenc:string[]">
<item>DMC4BY1V3UGZ</item>
<item>DMC4BY1V3UH0</item>
</consignmentCodes>
</ser:markConsignmentsAsReadyToManifest>
</soapenv:Body>
</soapenv:Envelope>
If the input is valid, then the consignment statuses are updated, and true
is returned, as in the example below.
Notice
The maximum number of consignments that can be submitted in a single API request is 999.
<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:markConsignmentsAsReadyToManifestResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
<markConsignmentsAsReadyToManifestReturn xsi:type="xsd:boolean">true</markConsignmentsAsReadyToManifestReturn>
</ns1:markConsignmentsAsReadyToManifestResponse>
</soapenv:Body>
</soapenv:Envelope>