scanCartonToManifestGroup

This method allows you to assign a new manifest group code to an existing carton, in readiness for manifesting (e.g. via createManifest or createManifestForFutureDespatch).

Note

This topic assumes that your OMS or WMS operates on carton values, as opposed to consignment codes.

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 scanCartonToManifestGroup,

  3. Enter the authorisation for the request.

  4. Specify the following:

    1. The cartonId (which can be associated with more than one parcel).

    2. The manifest group code.

  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:scanCartonToManifestGroup soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <cartonId xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">08K02JTY9</cartonId>
         <manifestGroupCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">TRUCK10</manifestGroupCode>
      </ser:scanCartonToManifestGroup>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then the carton is 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:scanCartonToManifestGroupResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <scanCartonToManifestGroupReturn xsi:type="xsd:boolean">true</scanCartonToManifestGroupReturn>
      </ns1:scanCartonToManifestGroupResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

If you wish to confirm the assignment, then, in the GUI:

  1. Find the carton, e.g.

    Scan-to-carton.png
  2. Go to the bottom left of the Advanced tab for the carton and verify that the Manifest Group Code has been added, e.g.

    Scan-to-carton-MAN-GRP.png