allocateConsignmentsWithBookingCode

This allocation method allocates one or more existing, unallocated consignments using a booking code.

How to submit a request

Proceed as follows:

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

  2. Create a new request under allocateConsignmentWithBookingCode.

  3. Enter the authorisation for the request.

  4. Specify the code(s) of the existing consignment(s).

  5. Specify the required bookingCode.

  6. Set calculateTaxAndDuty to false.

  7. Click Arrow.png to submit the request.

You know that allocation has been successful once a carrier service has been returned. You can then verify the allocation in the GUI (refer to Allocating an individual Consignment).

Tip

If no carrier service is returned, then you can verify whether any carrier maintenance is required, by either using the GUI Why Not? function or the API Debug Service Methods.

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="urn:DeliveryManager/services" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header />
   <soapenv:Body>
      <ser:allocateConsignmentsWithBookingCode 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>DMC4BY1TZCWS</item>
            <item>DMC4BY1TYSUU</item>
         </consignmentCodes>
         <bookingCode xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:string">@NEXT</bookingCode>
         <calculateTaxAndDuty xsi:type="xsd:boolean">false</calculateTaxAndDuty>
      </ser:allocateConsignmentsWithBookingCode>
   </soapenv:Body>
</soapenv:Envelope>

For an example response and how to process the information, see 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:allocateConsignmentsWithBookingCodeResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <allocateConsignmentsWithBookingCodeReturn soapenc:arrayType="ns2:Consignment[2]" xsi:type="soapenc:Array" xmlns:ns2="urn:DeliveryManager/types" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <allocateConsignmentsWithBookingCodeReturn xsi:type="ns2:Consignment">
               <CODAmount xsi:type="xsd:double">0.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">2317088000001402</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" xsi:nil="true"/>
               <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">DMC4BY1TZCWS</consignmentCode>
               <consignmentLevelDetailsFlag xsi:type="xsd:boolean">true</consignmentLevelDetailsFlag>
               <consignmentValue xsi:type="xsd:double">0.0</consignmentValue>
               <consignmentValueCurrencyCode xsi:type="soapenc:string">GBP</consignmentValueCurrencyCode>
               <consignmentValueCurrencyRate xsi:type="xsd:double">1.0</consignmentValueCurrencyRate>
               <consignmentWeight xsi:type="xsd:double">0.1</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-05-27T17:00:00.000Z</cutOffDate>
               <despatchDate xsi:type="xsd:dateTime">2020-05-27T17:30:00.000Z</despatchDate>
               <earliestDeliveryDate xsi:type="xsd:dateTime">2020-05-28T07: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-05-28T19:00:59.999Z</guaranteedDeliveryDate>
               <hazardCodes xsi:type="soapenc:Array" xsi:nil="true"/>
               <hazardousGoodsFlag xsi:type="xsd:boolean">false</hazardousGoodsFlag>
               <insuranceValue xsi:type="xsd:double">0.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">0.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">test01234</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">08K02JTY8</cartonId>
                     <code xsi:type="soapenc:string">2317088000001402</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[1]" xsi:type="soapenc:Array">
                        <products xsi:type="ns2:Product">
                           <countryOfOrigin xsi:type="soapenc:string">GBR</countryOfOrigin>
                           <fabricContent xsi:type="soapenc:string">1</fabricContent>
                           <harmonisedProductCode xsi:type="soapenc:string">1</harmonisedProductCode>
                           <miscellaneousInfo xsi:type="soapenc:Array" xsi:nil="true"/>
                           <productCode xsi:type="soapenc:string">1</productCode>
                           <productDescription xsi:type="soapenc:string">1</productDescription>
                           <productQuantity xsi:type="xsd:long">1</productQuantity>
                           <productTypeDescription xsi:type="soapenc:string">1</productTypeDescription>
                           <totalProductValue xsi:type="xsd:double">1.0</totalProductValue>
                           <unitProductWeight xsi:type="xsd:double">1.0</unitProductWeight>
                        </products>
                     </products>
                     <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">2317088000001402</trackingCode>
                     <trackingUrl xsi:type="soapenc:string">https://www.hermesworld.com/en/our_services/distribution/uk_distribution/parcel_tracking/parcel-tracking.html?trackingNumber=2317088000001402</trackingUrl>
                  </parcels>
               </parcels>
               <pickTicketNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <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">0005888</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string">C-ROUND 1704    1704</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    52      52</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">VAN     88      88</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">DEPOT   SWIN    23      58</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">allocation.bookingcode</propertyName>
                     <propertyValue xsi:type="soapenc:string">@NEXT</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.consignment.barcodeprefix</propertyName>
                     <propertyValue xsi:type="soapenc:string">2317088</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">3728957</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level5</propertyName>
                     <propertyValue xsi:type="soapenc:string">0005888</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string">C-ROUND 1704    1704</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string">DROP    52      52</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">VAN     88      88</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">DEPOT   SWIN    23      58</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">20200527</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">CISCO INTERNATIONAL LTD</line1>
                  <line2 xsi:type="soapenc:string">300 LONGWATER AVENUE</line2>
                  <line3 xsi:type="soapenc:string">READING</line3>
                  <line4 xsi:type="soapenc:string">BERKS</line4>
                  <postCode xsi:type="soapenc:string">RG2 6GE</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>
               </recipientAddress>
               <recipientCode xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientContactPhone xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientEmail xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientMobilePhone xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientName xsi:type="soapenc:string">Cisco</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" xsi:nil="true"/>
                  <countryCode xsi:type="soapenc:string" xsi:nil="true"/>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string" xsi:nil="true"/>
                  <line2 xsi:type="soapenc:string" xsi:nil="true"/>
                  <line3 xsi:type="soapenc:string" xsi:nil="true"/>
                  <line4 xsi:type="soapenc:string" xsi:nil="true"/>
                  <postCode xsi:type="soapenc:string" xsi:nil="true"/>
                  <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"/>
               <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"/>
                  <countryCode xsi:type="soapenc:string">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string">900 LONGWATER AVENUE</line1>
                  <line2 xsi:type="soapenc:string">READING</line2>
                  <line3 xsi:type="soapenc:string"/>
                  <line4 xsi:type="soapenc:string"/>
                  <postCode xsi:type="soapenc:string">RG2 6GE</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" xsi:nil="true"/>
               <senderEmail xsi:type="soapenc:string" xsi:nil="true"/>
               <senderFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <senderLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <senderMobilePhone xsi:type="soapenc:string" xsi:nil="true"/>
               <senderName xsi:type="soapenc:string">Reading Warehouse</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"/>
               <senderVatNumber 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">7.0</shippingCharge>
               <shippingChargeCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <shippingChargeCurrencyRate xsi:type="xsd:double">0.0</shippingChargeCurrencyRate>
               <shippingCost xsi:type="xsd:double">7.7</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" xsi:nil="true"/>
               <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>
            </allocateConsignmentsWithBookingCodeReturn>
            <allocateConsignmentsWithBookingCodeReturn xsi:type="ns2:Consignment">
               <CODAmount xsi:type="xsd:double">0.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">3929198000000803</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" xsi:nil="true"/>
               <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">DMC4BY1TYSUU</consignmentCode>
               <consignmentLevelDetailsFlag xsi:type="xsd:boolean">true</consignmentLevelDetailsFlag>
               <consignmentValue xsi:type="xsd:double">0.0</consignmentValue>
               <consignmentValueCurrencyCode xsi:type="soapenc:string">GBP</consignmentValueCurrencyCode>
               <consignmentValueCurrencyRate xsi:type="xsd:double">1.0</consignmentValueCurrencyRate>
               <consignmentWeight xsi:type="xsd:double">0.1</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-05-27T17:00:00.000Z</cutOffDate>
               <despatchDate xsi:type="xsd:dateTime">2020-05-27T17:30:00.000Z</despatchDate>
               <earliestDeliveryDate xsi:type="xsd:dateTime">2020-05-28T07: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-05-28T19:00:59.999Z</guaranteedDeliveryDate>
               <hazardCodes xsi:type="soapenc:Array" xsi:nil="true"/>
               <hazardousGoodsFlag xsi:type="xsd:boolean">false</hazardousGoodsFlag>
               <insuranceValue xsi:type="xsd:double">0.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">0.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">test01234</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" xsi:nil="true"/>
                     <code xsi:type="soapenc:string">3929198000000803</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">3929198000000803</trackingCode>
                     <trackingUrl xsi:type="soapenc:string">https://www.hermesworld.com/en/our_services/distribution/uk_distribution/parcel_tracking/parcel-tracking.html?trackingNumber=3929198000000803</trackingUrl>
                  </parcels>
               </parcels>
               <pickTicketNumber xsi:type="soapenc:string" xsi:nil="true"/>
               <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">0005688</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string">C-ROUND 2424    2424</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    44      44</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">VAN     88      88</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">DEPOT   GATW    21      56</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.manifest.areas</propertyName>
                     <propertyValue xsi:type="soapenc:string">826,826,3900</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">allocation.bookingcode</propertyName>
                     <propertyValue xsi:type="soapenc:string">@NEXT</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.consignment.barcodeprefix</propertyName>
                     <propertyValue xsi:type="soapenc:string">3929198</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 2916    2916</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string">DROP    53      53</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">20200527</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">200 Gray’s Inn Road</line1>
                  <line2 xsi:type="soapenc:string">london</line2>
                  <line3 xsi:type="soapenc:string"/>
                  <line4 xsi:type="soapenc:string"/>
                  <postCode xsi:type="soapenc:string">WC1X 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>
               </recipientAddress>
               <recipientCode xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientContactPhone xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientEmail xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientMobilePhone xsi:type="soapenc:string" xsi:nil="true"/>
               <recipientName xsi:type="soapenc:string">TEST PARCEL</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" xsi:nil="true"/>
                  <countryCode xsi:type="soapenc:string" xsi:nil="true"/>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string" xsi:nil="true"/>
                  <line2 xsi:type="soapenc:string" xsi:nil="true"/>
                  <line3 xsi:type="soapenc:string" xsi:nil="true"/>
                  <line4 xsi:type="soapenc:string" xsi:nil="true"/>
                  <postCode xsi:type="soapenc:string" xsi:nil="true"/>
                  <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"/>
               <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"/>
                  <countryCode xsi:type="soapenc:string">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string">BOURJOIS HOUSE, QUEENSWAY</line1>
                  <line2 xsi:type="soapenc:string">CROYDON</line2>
                  <line3 xsi:type="soapenc:string"/>
                  <line4 xsi:type="soapenc:string"/>
                  <postCode xsi:type="soapenc:string">CR9 4DL</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" xsi:nil="true"/>
               <senderEmail xsi:type="soapenc:string" xsi:nil="true"/>
               <senderFirstName xsi:type="soapenc:string" xsi:nil="true"/>
               <senderLastName xsi:type="soapenc:string" xsi:nil="true"/>
               <senderMobilePhone xsi:type="soapenc:string" xsi:nil="true"/>
               <senderName xsi:type="soapenc:string">Chanel</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"/>
               <senderVatNumber 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">7.0</shippingCharge>
               <shippingChargeCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
               <shippingChargeCurrencyRate xsi:type="xsd:double">0.0</shippingChargeCurrencyRate>
               <shippingCost xsi:type="xsd:double">7.7</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" xsi:nil="true"/>
               <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>
            </allocateConsignmentsWithBookingCodeReturn>
         </allocateConsignmentsWithBookingCodeReturn>
      </ns1:allocateConsignmentsWithBookingCodeResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

You should confirm that the carrier information is as required for each allocated consignment, e.g.

<carrierCode xsi:type="soapenc:string">HERMESPOS</carrierCode>
<carrierConsignmentCode xsi:type="soapenc:string">2317088000001402</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>

If the carrier service selected for any of the allocations is not the one required, then go to Cancel an Allocation. Alternatively, if the response is as required, then you can save it to your database.

Note

There are carrier routing properties returned for each allocated consignment that can help you plan your deliveries and keep your consumers updated.

Cancel an Allocation

Either use the deallocate method, or use the GUI as follows:

  1. Log into the Delivery Manager Delta environment via the user account that was used to run the API:

    https://dm-delta.metapack.com/dm/ActionServlet?action=home
  2. Click Home and then select the Allocated status, followed by Search.

    Allocated_Status_2.png
  3. Find the required consignment using the newly generated carrierConsignmentCode, open the consignment, and then click Cancel Allocation:

    Cancel_Allocation_3.png
  4. Once you confirm the deallocation, the consignment is moved to the Unallocated status.