1. Metapack
  2. Shipping
  3. SOAP Shipping API
  4. Allocation Service

despatchConsignmentWithBookingCode (Return)

This allocation method can be used to create a single return consignment, allocate it using a booking code, and generate the Base64-encoded returns label (refer to Generating returns labels).

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, Booking Codes and the Allocation Filter and Printing Properties.

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 despatchConsignmentWithBookingCode.

  3. Enter the authorisation for the request.

  4. Create a new single consignment as for despatchConsignmentWithBookingCode, but bear in mind that the sender and recipient information should be reversed, i.e.

    1. The recipientAddress, which, for a delivery, contains the consumer delivery address, should instead contain the seller's warehouse address.

    2. The recipientCode should contain the warehouse code.

    3. The senderAddress, which, for a delivery, contains the seller's warehouse address, should instead contain the original consumer delivery address.

    4. The senderCode, which, for a delivery, contains the warehouse code, should be removed.

    5. The senderName should contain the name of the consumer.

  5. In addition:

    1. The returnAddress should contain the address of the person returning the goods (this appears after the returnName in the FROM: line at the bottom of the label).

    2. The returnName should contain the name of the person returning the goods (this appears before the returnAddress in the FROM: line at the bottom of the label).

  6. Set the transactionType to Pick-up, as opposed to Delivery.

  7. Specify the required bookingCode.

  8. Set calculateTaxAndDuty to false.

  9. Enter the parameters for document generation.

  10. Click Arrow.png to submit the request.

Note

If you are using any form of performance reporting, specifically Ops Reporting and Delivery Intelligence, and you want to view customer delivery data, you should add the committedDeliveryWindow parameter to your API call when creating your consignments (see the following example).

<committedDeliveryWindow xsi:type="ns2:DateRange">
<from xsi:type="xsd:dateTime">2020-11-24T18:30:00.000Z
</from>
<to xsi:type="xsd:dateTime">2020-11-25T18:30:00.000Z</to>
</committedDeliveryWindow>

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: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:despatchConsignmentWithBookingCode soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <consignment xsi:type="typ:Consignment" xmlns:typ="urn:DeliveryManager/types">
             <cartonNumber xsi:type="ns2:string">SR6001085134</cartonNumber>
               <consignmentLevelDetailsFlag xsi:type="ns1:boolean">false</consignmentLevelDetailsFlag>
               <consignmentValue xsi:type="ns1:double">0</consignmentValue>
               <consignmentValueCurrencyCode xsi:type="ns2:string">GBP</consignmentValueCurrencyCode>
               <consignmentWeight xsi:type="ns1:double">5.0</consignmentWeight>
               <insuranceValue xsi:type="ns1:double">0.15</insuranceValue>
               <orderDate xsi:type="ns1:dateTime">2018-12-14T10:17:49Z</orderDate>
               <orderNumber xsi:type="ns2:string">SR6001085133</orderNumber>
               <orderValue xsi:type="ns1:double">49.98000</orderValue>
               <parcelCount xsi:type="ns1:int">1</parcelCount>
               <parcels soapenc:arrayType="ns2:Parcel[1]" xsi:type="soapenc:Array">
                  <parcels xsi:type="ns2:Parcel">
                     <cartonId xsi:type="soapenc:string">08K02JTXC</cartonId>
                     <code xsi:type="soapenc:string" xsi:nil="true"/>
                     <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>
                     <parcelDepth xsi:type="xsd:double">61.0</parcelDepth>
                     <parcelHeight xsi:type="xsd:double">45.0</parcelHeight>
                     <parcelValue xsi:type="xsd:double">1.0</parcelValue>
                     <parcelWeight xsi:type="xsd:double">1.0</parcelWeight>
                     <parcelWidth xsi:type="xsd:double">44.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>
                  </parcels>
               </parcels>
               <recipientAddress xsi:type="ns3:Address">
                  <countryCode xsi:type="ns2:string">GB</countryCode>
                  <line1 xsi:type="ns2:string">READING WAREHOUSE</line1>
                  <line2 xsi:type="ns2:string">900 LONGWATER AVENUE</line2>
                  <line3 xsi:type="ns2:string">READING</line3>
                  <line4 xsi:type="ns2:string">BERKSHIRE</line4>
                  <postCode xsi:type="ns2:string">RG2 6GE</postCode>
               </recipientAddress>
               <recipientCode xsi:type="ns2:string">READING1</recipientCode>
               <recipientName xsi:type="ns2:string">RETURNS DEPARTMENT</recipientName>
               <returnAddress xsi:type="ns3:Address">
                  <countryCode xsi:type="ns2:string">GB</countryCode>
                  <line1 xsi:type="ns2:string">The White Building</line1>
                  <line2 xsi:type="ns2:string">33 Kings Road</line2>
                  <line3 xsi:type="ns2:string">READING</line3>
                  <line4 xsi:type="ns2:string">BERKSHIRE</line4>
                  <postCode xsi:type="ns2:string">RG1 3AR</postCode>
               </returnAddress>
               <returnName xsi:type="soapenc:string">Walter White</returnName>
               <senderAddress xsi:type="ns3:Address">
                  <countryCode xsi:type="ns2:string">GB</countryCode>
                  <line1 xsi:type="ns2:string">The White Building</line1>
                  <line2 xsi:type="ns2:string">33 Kings Road</line2>
                  <line3 xsi:type="ns2:string">READING</line3>
                  <line4 xsi:type="ns2:string">BERKSHIRE</line4>
                  <postCode xsi:type="ns2:string">RG1 3AR</postCode>
               </senderAddress>
               <senderEmail xsi:type="ns2:string">walterwhite@thewhitebuilding.com</senderEmail>
               <senderName xsi:type="ns2:string">Walter White</senderName>
               <shipmentTypeCode xsi:type="ns2:string">MERCHANDISE</shipmentTypeCode>
               <transactionType xsi:type="ns2:string">PICK-UP</transactionType>
         </consignment>
         <bookingCode xsi:type="soapenc:string">@RETURNS</bookingCode>
         <calculateTaxAndDuty xsi:type="xsd:boolean">false</calculateTaxAndDuty>
          <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:despatchConsignmentWithBookingCode>
   </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:despatchConsignmentWithBookingCodeResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <despatchConsignmentWithBookingCodeReturn xsi:type="ns2:DespatchedConsignment" xmlns:ns2="urn:DeliveryManager/types">
            <consignment xsi:type="ns2:Consignment">
               <CODAmount xsi:type="xsd:double">1.0</CODAmount>
               <CODFlag xsi:type="xsd:boolean">false</CODFlag>
               <CODPaymentTypeCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">CAS</CODPaymentTypeCode>
               <CODSpecialInstruction xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <CODSurcharge xsi:type="xsd:double">0.0</CODSurcharge>
               <alreadyPalletisedGoodsFlag xsi:type="xsd:boolean">false</alreadyPalletisedGoodsFlag>
               <cardNumber xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <carrierCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">ROYALMAILTRKNOOBA</carrierCode>
               <carrierConsignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">000000249</carrierConsignmentCode>
               <carrierName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Royal Mail Tracked non-OBA</carrierName>
               <carrierServiceCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">RMTRACKEDSTDNOSIGRTN</carrierServiceCode>
               <carrierServiceName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Tracked Returns 48</carrierServiceName>
               <carrierServiceVATRate xsi:type="xsd:double">0.0</carrierServiceVATRate>
               <cartonNumber xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">SR6001085134</cartonNumber>
               <cashOnDeliveryCurrency xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">GBP</cashOnDeliveryCurrency>
               <committedCollectionWindow xsi:type="ns2:DateRange" xsi:nil="true"/>
               <committedDeliveryWindow xsi:type="ns2:DateRange" xsi:nil="true"/>
               <consDestinationReference xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <consOriginReference xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <consRecipientReference xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <consReference xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <consSenderReference xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <consignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DMC4BY1U649V</consignmentCode>
               <consignmentLevelDetailsFlag xsi:type="xsd:boolean">false</consignmentLevelDetailsFlag>
               <consignmentValue xsi:type="xsd:double">1.0</consignmentValue>
               <consignmentValueCurrencyCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">GBP</consignmentValueCurrencyCode>
               <consignmentValueCurrencyRate xsi:type="xsd:double">1.0</consignmentValueCurrencyRate>
               <consignmentWeight xsi:type="xsd:double">1.0</consignmentWeight>
               <custom1 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom10 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom2 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom3 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom4 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom5 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom6 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom7 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom8 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <custom9 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <customsDocumentationRequired xsi:type="xsd:boolean">false</customsDocumentationRequired>
               <cutOffDate xsi:type="xsd:dateTime">2020-06-01T22:00:00.000Z</cutOffDate>
               <despatchDate xsi:type="xsd:dateTime">2020-06-02T07:00:00.000Z</despatchDate>
               <earliestDeliveryDate xsi:type="xsd:dateTime">2020-06-03T05:31:00.000Z</earliestDeliveryDate>
               <endVatNumber xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <fragileGoodsFlag xsi:type="xsd:boolean">false</fragileGoodsFlag>
               <guaranteedDeliveryDate xsi:type="xsd:dateTime">2020-06-05T16:00:59.999Z</guaranteedDeliveryDate>
               <hazardCodes xsi:type="soapenc:Array" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <hazardousGoodsFlag xsi:type="xsd:boolean">false</hazardousGoodsFlag>
               <insuranceValue xsi:type="xsd:double">0.15</insuranceValue>
               <insuranceValueCurrencyCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <insuranceValueCurrencyRate xsi:type="xsd:double">0.0</insuranceValueCurrencyRate>
               <languageCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">en</languageCode>
               <liquidGoodsFlag xsi:type="xsd:boolean">false</liquidGoodsFlag>
               <manifestGroupCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <maxDimension xsi:type="xsd:double">61.0</maxDimension>
               <metaCampaignKey xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <metaCustomerKey xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <moreThanOneMetreGoodsFlag xsi:type="xsd:boolean">false</moreThanOneMetreGoodsFlag>
               <moreThanTwentyFiveKgGoodsFlag xsi:type="xsd:boolean">false</moreThanTwentyFiveKgGoodsFlag>
               <orderDate xsi:type="xsd:dateTime">2018-12-14T10:17:49.000Z</orderDate>
               <orderNumber xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">SR6001085133</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" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
                  <parcels xsi:type="ns2:Parcel">
                     <CODParcelAmount xsi:type="xsd:double">0.0</CODParcelAmount>
                     <cartonId xsi:type="soapenc:string">08K02JTXC</cartonId>
                     <code xsi:type="soapenc:string">000000249</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">61.0</parcelDepth>
                     <parcelHeight xsi:type="xsd:double">45.0</parcelHeight>
                     <parcelPrintStatus xsi:type="soapenc:string">Printed</parcelPrintStatus>
                     <parcelValue xsi:type="xsd:double">1.0</parcelValue>
                     <parcelWeight xsi:type="xsd:double">1.0</parcelWeight>
                     <parcelWidth xsi:type="xsd:double">44.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">000000249</trackingCode>
                     <trackingUrl xsi:type="soapenc:string">http://royalmail.com/portal/rm/track?trackNumber=000000249</trackingUrl>
                  </parcels>
               </parcels>
               <pickTicketNumber xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <pickupPoint xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <podRequired xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">any</podRequired>
               <properties soapenc:arrayType="ns2:Property[17]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
                  <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"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field1</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level5</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level5</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.manifest.areas</propertyName>
                     <propertyValue xsi:type="soapenc:string">0,0,0</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">0</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.version</propertyName>
                     <propertyValue xsi:type="soapenc:string">20200430</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">0</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">0</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collection.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">0</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">allocation.bookingcode</propertyName>
                     <propertyValue xsi:type="soapenc:string">@RETURNS</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.collectingdepot.code</propertyName>
                     <propertyValue xsi:type="soapenc:string">002622</propertyValue>
                  </properties>
               </properties>
               <recipientAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <countryCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <line1 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING WAREHOUSE</line1>
                  <line2 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">900 LONGWATER AVENUE</line2>
                  <line3 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING</line3>
                  <line4 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">BERKSHIRE</line4>
                  <postCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">RG2 6GE</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetType xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <town xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <type xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Business</type>
               </recipientAddress>
               <recipientCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING1</recipientCode>
               <recipientContactPhone xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientEmail xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientFirstName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientLastName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientMobilePhone xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">RETURNS DEPARTMENT</recipientName>
               <recipientNotificationType xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">N</recipientNotificationType>
               <recipientPhone xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientTimeZone xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Europe/London</recipientTimeZone>
               <recipientTitle xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <recipientVatNumber xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <returnAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <countryCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <line1 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">The White Building</line1>
                  <line2 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">33 Kings Road</line2>
                  <line3 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING</line3>
                  <line4 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">BERKSHIRE</line4>
                  <postCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">RG1 3AR</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetType xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <town xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <type xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Business</type>
               </returnAddress>
               <returnEmail xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <returnFirstName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <returnLastName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <returnMobile xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <returnName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Walter White</returnName>
               <returnPhone xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <returnTitle xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <countryCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <line1 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">The White Building</line1>
                  <line2 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">33 Kings Road</line2>
                  <line3 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING</line3>
                  <line4 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">BERKSHIRE</line4>
                  <postCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">RG1 3AR</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <streetType xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <town xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <type xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Business</type>
               </senderAddress>
               <senderCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderContactPhone xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderEmail xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">walterwhite@thewhitebuilding.com</senderEmail>
               <senderFirstName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderLastName xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderMobilePhone xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Walter White</senderName>
               <senderNotificationType xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">N</senderNotificationType>
               <senderPhone xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <senderTimeZone xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Europe/London</senderTimeZone>
               <senderTitle xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <startVatNumber xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <shipmentTypeCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">MERCHANDISE</shipmentTypeCode>
               <shippingAccount xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <shippingCharge xsi:type="xsd:double">0.0</shippingCharge>
               <shippingChargeCurrencyCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <shippingChargeCurrencyRate xsi:type="xsd:double">0.0</shippingChargeCurrencyRate>
               <shippingCost xsi:type="xsd:double">0.75</shippingCost>
               <shippingCostCurrencyCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <shippingCostCurrencyRate xsi:type="xsd:double">0.0</shippingCostCurrencyRate>
               <signatoryOnCustoms xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <specialInstructions1 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <specialInstructions2 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <startVatNumber xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <status xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Ready to manifest</status>
               <taxAndDuty xsi:type="xsd:double">0.0</taxAndDuty>
               <taxAndDutyCurrencyCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <taxAndDutyCurrencyRate xsi:type="xsd:double">0.0</taxAndDutyCurrencyRate>
               <taxAndDutyStatusText xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <taxDutyDeclarationCurrencyCode xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <termsOfTradeCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DAP</termsOfTradeCode>
               <transactionType xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Pick-up</transactionType>
               <twoManLiftFlag xsi:type="xsd:boolean">false</twoManLiftFlag>
            </consignment>
            <paperwork xsi:type="ns2:Paperwork">
               <documents xsi:type="soapenc:base64Binary" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <labels xsi:type="soapenc:base64Binary" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">JVBERi0xLjQKJeLj...9TaXplIDE3Pj4Kc3RhcnR4cmVmCjgzNDg2CiUlRU9GCg==</labels>
            </paperwork>
         </despatchConsignmentWithBookingCodeReturn>
      </ns1:despatchConsignmentWithBookingCodeResponse>
   </soapenv:Body>
</soapenv:Envelope>

Next Steps

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

<carrierCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">ROYALMAILTRKNOOBA</carrierCode>
<carrierConsignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">000000249</carrierConsignmentCode>
<carrierName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Royal Mail Tracked non-OBA</carrierName>
<carrierServiceCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">RMTRACKEDSTDNOSIGRTN</carrierServiceCode>
<carrierServiceName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Tracked Returns 48</carrierServiceName>

If the carrier service is not the one required, then go to Cancel the Allocation. Otherwise, save the response to your database and go to Decode and Print the Labels and Customs Documents.

Cancel the 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 Ready to manifest status, followed by Search.

    Import_new_nav_bar_4.png

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

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

Decode and Print the Labels and Customs Documents

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.