This method creates the labels and customs documents for one or more allocated consignments, in a Base64-encoded format.
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 and Printing Properties.
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
createPaperworkForConsignments
. -
Enter the authorisation for the request.
-
Specify the code(s) of the existing consignment(s) for which paperwork is to be generated.
-
Enter the parameters for document generation.
-
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" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<ser:createPaperworkForConsignments 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>DMC4BY1V5GA6</item>
<item>DMC4BY1V6DEV</item>
</consignmentCodes>
<parameters xmlns:tns="http://schemas.xmlsoap.org/soap/envelope/">
<Property>
<propertyName>type</propertyName>
<propertyValue>all</propertyValue>
</Property>
<Property>
<propertyName>format</propertyName>
<propertyValue>pdf</propertyValue>
</Property>
<Property>
<propertyName>dimension</propertyName>
<propertyValue>6x4</propertyValue>
</Property>
</parameters>
</ser:createPaperworkForConsignments>
</soapenv:Body>
</soapenv:Envelope>
For an example response and how to process the information, see below.
<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:createPaperworkForConsignmentsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
<createPaperworkForConsignmentsReturn xsi:type="ns2:Paperwork" xmlns:ns2="urn:DeliveryManager/types">
<documents xsi:type="soapenc:base64Binary" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">JVBERi.....JUVPRgo=</documents>
<labels xsi:type="soapenc:base64Binary" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">JVBERi.....JSVFT0YK</labels>
</createPaperworkForConsignmentsReturn>
</ns1:createPaperworkForConsignmentsResponse>
</soapenv:Body>
</soapenv:Envelope>
The results are generated in up to two strings at the bottom of the response: a labels
string containing the label(s) for each parcel, and a documents
string containing the customs documents.
In the example response, the Base64-encoded strings have been truncated for aesthetic purposes.
To generate the labels
or documents
from the string, you need to copy and load the string into a Base64 decoder. For more information about this, refer to Store the Paperwork and Print Later.