addConsignmentsToGroup

This method assigns the specified manifest group code to an array of consignments in readiness for manifesting (e.g. via createManifest or createManifestForFutureDespatch).

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:

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

  2. Create a new request under addConsignmentsToGroup,

  3. Enter the authorisation for the request.

  4. Specify the following:

    1. The code(s) of the existing consignment(s).

    2. The manifest group code to be added.

  5. Click Arrow.png 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:addConsignmentsToGroup 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>DMC4BY1V2KYG</item>
            <item>DMC4BY1V2KYI</item>
         </consignmentCodes>
         <manifestGroupCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">TRUCK10</manifestGroupCode>
      </ser:addConsignmentsToGroup>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then the consignments are assigned to the newly created manifest group, 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:addConsignmentsToGroupResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <addConsignmentsToGroupReturn xsi:type="xsd:boolean">true</addConsignmentsToGroupReturn>
      </ns1:addConsignmentsToGroupResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

If you wish to confirm the assignment, then, in the GUI, go to the bottom left of the Advanced tab for one of the consignments and verify that the Manifest Group Code has been added, e.g.

Manifest_Group_Add.png