findConsignmentsByParcelCode

This method allows you to return the allocated consignment(s) associated with a specified parcel barcode. The associated carrier routing information is also returned for each consignment, as a series of properties,

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 ConsignmentSearchService.xml.
Create a new request under findConsignmentsByParcelCode,
Enter the authorisation for the request.
Specify the parcelCode (barcode).
Click 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:findConsignmentsByParcelCode soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <parcelCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">3934198000001901</parcelCode>
      </ser:findConsignmentsByParcelCode>
   </soapenv:Body>
</soapenv:Envelope>

If the input is valid, then the consignment(s) associated with the specified parcel is returned, together with the associated carrier information, 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:findConsignmentsByParcelCodeResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <findConsignmentsByParcelCodeReturn soapenc:arrayType="ns2:Consignment[1]" xsi:type="soapenc:Array" xmlns:ns2="urn:DeliveryManager/types" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <findConsignmentsByParcelCodeReturn xsi:type="ns2:Consignment">
               <CODAmount xsi:type="xsd:double">99.0</CODAmount>
               <CODFlag xsi:type="xsd:boolean">false</CODFlag>
               <CODPaymentTypeCode xsi:type="soapenc:string">CAS</CODPaymentTypeCode>
               <CODSpecialInstruction xsi:type="soapenc:string" xsi:nil="true"/>
               <CODSurcharge xsi:type="xsd:double">0.0</CODSurcharge>
               <alreadyPalletisedGoodsFlag xsi:type="xsd:boolean">false</alreadyPalletisedGoodsFlag>
               <cardNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <carrierCode xsi:type="soapenc:string">HERMESPOS</carrierCode>
               <carrierConsignmentCode xsi:type="soapenc:string">3934198000001901</carrierConsignmentCode>
               <carrierName xsi:type="soapenc:string">Hermes</carrierName>
               <carrierServiceCode xsi:type="soapenc:string">HERMNDG</carrierServiceCode>
               <carrierServiceName xsi:type="soapenc:string">Courier Service Next Day</carrierServiceName>
               <carrierServiceVATRate xsi:type="xsd:double">0.0</carrierServiceVATRate>
               <cartonNumber xsi:type="soapenc:string">testCarton</cartonNumber>
               <cashOnDeliveryCurrency xsi:type="soapenc:string">GBP</cashOnDeliveryCurrency>
               <committedCollectionWindow xsi:type="ns2:DateRange" xsi:nil="true"/>
               <committedDeliveryWindow xsi:type="ns2:DateRange" xsi:nil="true"/>
               <consDestinationReference xsi:type="soapenc:string" xsi:nil="true"/>
               <consOriginReference xsi:type="soapenc:string" xsi:nil="true"/>
               <consRecipientReference xsi:type="soapenc:string" xsi:nil="true"/>
               <consReference xsi:type="soapenc:string" xsi:nil="true"/>
               <consSenderReference xsi:type="soapenc:string" xsi:nil="true"/>
               <consignmentCode xsi:type="soapenc:string">DMC4BY1V48XK</consignmentCode>
               <consignmentLevelDetailsFlag xsi:type="xsd:boolean">true</consignmentLevelDetailsFlag>
               <consignmentValue xsi:type="xsd:double">199.0</consignmentValue>
               <consignmentValueCurrencyCode xsi:type="soapenc:string">GBP</consignmentValueCurrencyCode>
               <consignmentValueCurrencyRate xsi:type="xsd:double">1.0</consignmentValueCurrencyRate>
               <consignmentWeight xsi:type="xsd:double">66.0</consignmentWeight>
               <custom1 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom10 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom2 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom3 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom4 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom5 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom6 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom7 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom8 xsi:type="soapenc:string" xsi:nil="true"/>
               <custom9 xsi:type="soapenc:string" xsi:nil="true"/>
               <customsDocumentationRequired xsi:type="xsd:boolean">false</customsDocumentationRequired>
               <cutOffDate xsi:type="xsd:dateTime">2020-08-04T17:00:00.000Z</cutOffDate>
               <despatchDate xsi:type="xsd:dateTime">2020-08-04T17:30:00.000Z</despatchDate>
               <earliestDeliveryDate xsi:type="xsd:dateTime">2020-08-05T07:00:00.000Z</earliestDeliveryDate>
               <endVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <fragileGoodsFlag xsi:type="xsd:boolean">false</fragileGoodsFlag>
               <guaranteedDeliveryDate xsi:type="xsd:dateTime">2020-08-05T19:00:59.000Z</guaranteedDeliveryDate>
               <hazardCodes xsi:type="soapenc:Array" xsi:nil="true"/>
               <hazardousGoodsFlag xsi:type="xsd:boolean">false</hazardousGoodsFlag>
               <insuranceValue xsi:type="xsd:double">166.0</insuranceValue>
               <insuranceValueCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <insuranceValueCurrencyRate xsi:type="xsd:double">0.0</insuranceValueCurrencyRate>
               <languageCode xsi:type="soapenc:string">en</languageCode>
               <liquidGoodsFlag xsi:type="xsd:boolean">false</liquidGoodsFlag>
               <manifestGroupCode xsi:type="soapenc:string" xsi:nil="true"/>
               <maxDimension xsi:type="xsd:double">55.0</maxDimension>
               <metaCampaignKey xsi:type="soapenc:string" xsi:nil="true"/>
               <metaCustomerKey xsi:type="soapenc:string" xsi:nil="true"/>
               <moreThanOneMetreGoodsFlag xsi:type="xsd:boolean">false</moreThanOneMetreGoodsFlag>
               <moreThanTwentyFiveKgGoodsFlag xsi:type="xsd:boolean">false</moreThanTwentyFiveKgGoodsFlag>
               <orderDate xsi:type="xsd:dateTime" xsi:nil="true"/>
               <orderNumber xsi:type="soapenc:string">TEST03</orderNumber>
               <orderValue xsi:type="xsd:double">0.0</orderValue>
               <parcelCount xsi:type="xsd:int">1</parcelCount>
               <parcels soapenc:arrayType="ns2:Parcel[1]" xsi:type="soapenc:Array">
                  <parcels xsi:type="ns2:Parcel">
                     <CODParcelAmount xsi:type="xsd:double">0.0</CODParcelAmount>
                     <cartonId xsi:type="soapenc:string">testCarton</cartonId>
                     <code xsi:type="soapenc:string">3934198000001901</code>
                     <destinationReference xsi:type="soapenc:string" xsi:nil="true"/>
                     <dutyPaid xsi:type="xsd:double">0.0</dutyPaid>
                     <number xsi:type="xsd:int">1</number>
                     <originReference xsi:type="soapenc:string" xsi:nil="true"/>
                     <outerConsignmentCode xsi:type="soapenc:string" xsi:nil="true"/>
                     <outerParcelNumber xsi:type="xsd:int">0</outerParcelNumber>
                     <packageTypeCode xsi:type="soapenc:string" xsi:nil="true"/>
                     <parcelDepth xsi:type="xsd:double">0.0</parcelDepth>
                     <parcelHeight xsi:type="xsd:double">0.0</parcelHeight>
                     <parcelPrintStatus xsi:type="soapenc:string">Not Printed</parcelPrintStatus>
                     <parcelValue xsi:type="xsd:double">0.0</parcelValue>
                     <parcelWeight xsi:type="xsd:double">0.0</parcelWeight>
                     <parcelWidth xsi:type="xsd:double">0.0</parcelWidth>
                     <products soapenc:arrayType="ns2:Product[0]" xsi:type="soapenc:Array"/>
                     <recipientReference xsi:type="soapenc:string" xsi:nil="true"/>
                     <reference xsi:type="soapenc:string" xsi:nil="true"/>
                     <senderReference xsi:type="soapenc:string" xsi:nil="true"/>
                     <trackingCode xsi:type="soapenc:string">3934198000001901</trackingCode>
                     <trackingUrl xsi:type="soapenc:string">https://www.hermesworld.com/en/our_services/distribution/uk_distribution/parcel_tracking/parcel-tracking.html?trackingNumber=3934198000001901</trackingUrl>
                  </parcels>
               </parcels>
               <pickTicketNumber xsi:type="soapenc:string">1</pickTicketNumber>
               <pickupPoint xsi:type="soapenc:string" xsi:nil="true"/>
               <podRequired xsi:type="soapenc:string">any</podRequired>
               <properties soapenc:arrayType="ns2:Property[20]" xsi:type="soapenc:Array">
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level5</propertyName>
                     <propertyValue xsi:type="soapenc:string">0008885</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string">C-ROUND 1228    1228</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field20</propertyName>
                     <propertyValue xsi:type="soapenc:string">93918c6e-0ade-4876-8812-94448af20568</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collectingdepot.code</propertyName>
                     <propertyValue xsi:type="soapenc:string">95</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string">DROP    04      04</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">VAN     85      85</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">DEPOT   MDSN    68      88</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.manifest.areas</propertyName>
                     <propertyValue xsi:type="soapenc:string">826,826,3964</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.consignment.barcodeprefix</propertyName>
                     <propertyValue xsi:type="soapenc:string">3934198</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.consignment.deliverymod</propertyName>
                     <propertyValue xsi:type="soapenc:string">004ND</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.consignment.numberrangeid</propertyName>
                     <propertyValue xsi:type="soapenc:string">3728507</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level5</propertyName>
                     <propertyValue xsi:type="soapenc:string">0007898</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string">C-ROUND 3416    3416</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string">DROP    63      63</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">VAN     98      98</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">DEPOT   TRCK    39      78</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field3</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field2</propertyName>
                     <propertyValue xsi:type="soapenc:string">123456</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field1</propertyName>
                     <propertyValue xsi:type="soapenc:string">12345</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.version</propertyName>
                     <propertyValue xsi:type="soapenc:string">20200804</propertyValue>
                  </properties>
               </properties>
               <recipientAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string"/>
                  <countryCode xsi:type="soapenc:string">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string">Park Plaza Westminster Bridge London</line1>
                  <line2 xsi:type="soapenc:string">Westminster Bridge Road</line2>
                  <line3 xsi:type="soapenc:string">London</line3>
                  <line4 xsi:type="soapenc:string"/>
                  <postCode xsi:type="soapenc:string">SE1 7UT</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetName xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetType xsi:type="soapenc:string" xsi:nil="true"/>
                  <town xsi:type="soapenc:string" xsi:nil="true"/>
                  <type xsi:type="soapenc:string">Residential</type>
               </recipientAddress>
               <recipientCode xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientContactPhone xsi:type="soapenc:string">00000111225</recipientContactPhone>
               <recipientEmail xsi:type="soapenc:string">testRecipient@metapack.com</recipientEmail>
               <recipientFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientMobilePhone xsi:type="soapenc:string">00000111224</recipientMobilePhone>
               <recipientName xsi:type="soapenc:string">testRecipientName</recipientName>
               <recipientNotificationType xsi:type="soapenc:string">N</recipientNotificationType>
               <recipientPhone xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientTimeZone xsi:type="soapenc:string">Europe/London</recipientTimeZone>
               <recipientTitle xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <returnAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string">MetaPack Returns TEST</companyName>
                  <countryCode xsi:type="soapenc:string">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string">returnLine 1</line1>
                  <line2 xsi:type="soapenc:string">returnLine 2</line2>
                  <line3 xsi:type="soapenc:string">returnLine 3</line3>
                  <line4 xsi:type="soapenc:string">returnLine 4</line4>
                  <postCode xsi:type="soapenc:string">EC1X 8XZ</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetName xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetType xsi:type="soapenc:string" xsi:nil="true"/>
                  <town xsi:type="soapenc:string" xsi:nil="true"/>
                  <type xsi:type="soapenc:string">Business</type>
               </returnAddress>
               <returnEmail xsi:type="soapenc:string">testReturns@metapack.com</returnEmail>
               <returnFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <returnLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <returnMobile xsi:type="soapenc:string"/>
               <returnName xsi:type="soapenc:string"/>
               <returnPhone xsi:type="soapenc:string"/>
               <returnTitle xsi:type="soapenc:string" xsi:nil="true"/>
               <senderAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string">MetaPack Ltd TEST</companyName>
                  <countryCode xsi:type="soapenc:string">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string">senderLine 1</line1>
                  <line2 xsi:type="soapenc:string">senderLine 2</line2>
                  <line3 xsi:type="soapenc:string">senderLine 3</line3>
                  <line4 xsi:type="soapenc:string">senderLine 4</line4>
                  <postCode xsi:type="soapenc:string">ME1 1JT</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetName xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true"/>
                  <streetType xsi:type="soapenc:string" xsi:nil="true"/>
                  <town xsi:type="soapenc:string" xsi:nil="true"/>
                  <type xsi:type="soapenc:string">Business</type>
               </senderAddress>
               <senderCode xsi:type="soapenc:string">READING1</senderCode>
               <senderContactPhone xsi:type="soapenc:string">00000111223</senderContactPhone>
               <senderEmail xsi:type="soapenc:string">testSender@metapack.com</senderEmail>
               <senderFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <senderLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <senderMobilePhone xsi:type="soapenc:string">00000111222</senderMobilePhone>
               <senderName xsi:type="soapenc:string">testSenderName</senderName>
               <senderNotificationType xsi:type="soapenc:string">N</senderNotificationType>
               <senderPhone xsi:type="soapenc:string" xsi:nil="true"/>
               <senderTimeZone xsi:type="soapenc:string">Europe/London</senderTimeZone>
               <senderTitle xsi:type="soapenc:string" xsi:nil="true"/>
               <startVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <shipmentTypeCode xsi:type="soapenc:string">MERCHANDISE</shipmentTypeCode>
               <shippingAccount xsi:type="soapenc:string" xsi:nil="true"/>
               <shippingCharge xsi:type="xsd:double">0.0</shippingCharge>
               <shippingChargeCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <shippingChargeCurrencyRate xsi:type="xsd:double">0.0</shippingChargeCurrencyRate>
               <shippingCost xsi:type="xsd:double">76.75</shippingCost>
               <shippingCostCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <shippingCostCurrencyRate xsi:type="xsd:double">0.0</shippingCostCurrencyRate>
               <signatoryOnCustoms xsi:type="soapenc:string">The manager</signatoryOnCustoms>
               <specialInstructions1 xsi:type="soapenc:string">Leave it at the door please</specialInstructions1>
               <specialInstructions2 xsi:type="soapenc:string" xsi:nil="true"/>
               <startVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <status xsi:type="soapenc:string">Allocated</status>
               <taxAndDuty xsi:type="xsd:double">0.0</taxAndDuty>
               <taxAndDutyCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <taxAndDutyCurrencyRate xsi:type="xsd:double">0.0</taxAndDutyCurrencyRate>
               <taxAndDutyStatusText xsi:type="soapenc:string" xsi:nil="true"/>
               <taxDutyDeclarationCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <termsOfTradeCode xsi:type="soapenc:string">DAP</termsOfTradeCode>
               <transactionType xsi:type="soapenc:string">Delivery</transactionType>
               <twoManLiftFlag xsi:type="xsd:boolean">false</twoManLiftFlag>
            </findConsignmentsByParcelCodeReturn>
         </findConsignmentsByParcelCodeReturn>
      </ns1:findConsignmentsByParcelCodeResponse>
   </soapenv:Body>
</soapenv:Envelope>