Example: Use Shipping SOAP API to create a label

This example shows you how to use the Shipping SOAP to create, allocate, and manifest a UK domestic return. It also covers the steps needed to collect from the customer, if required.

The example uses the following API methods:

despatchConsignmentWithBookingCode (Return), which is also used to generate the documentation.
addConsignmentsToGroup to add the collection to a 'returns' manifest group.
createManifestForFutureDespatch to schedule all the due collections for a future pickup.

Creating and allocating the collection

Complete the following steps:

If you have not already done so, open a new project using the WSDL AllocationService.xml.
Create a new request under despatchConsignmentWithBookingCode.
Enter the authorisation for the request.
Create a new single consignment, but reverse the sender and recipient information that you would normally enter for a delivery:
- The recipientAddress should contain the address of the UK warehouse.
- The recipientCode should contain the code of the UK warehouse.
- The senderAddress should contain the original customer delivery address.
- The senderCode should be removed.
- The senderName should contain the name of the customer.
- 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.
- 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.
Set the transactionType as follows:
- Use Pick-up if you are collecting from the customer.
- Use Delivery if the customer is dropping off at a PUDO location.
Specify the required bookingCode.
Set calculateTaxAndDuty to false.
Enter the parameters for document generation.
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" 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">
               <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">2021-01-12T10:17:49Z</orderDate>
               <orderNumber xsi:type="ns2:string">SR6001085136PICKUP</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">
                     <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">300.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">300.0</totalProductValue>
                           <unitProductWeight xsi:type="xsd:double">1.0</unitProductWeight>
                        </products>
                     </products>
                  </parcels>
               </parcels>
               <recipientAddress xsi:type="ns3:Address">
                  <companyName xsi:type="ns2:string">READING WAREHOUSE</companyName>
                  <countryCode xsi:type="ns2:string">GB</countryCode>
                  <line1 xsi:type="ns2:string">900 LONGWATER AVENUE</line1>
                  <line2 xsi:type="ns2:string">READING</line2>
                  <line3 xsi:type="ns2:string">BERKSHIRE</line3>
                  <postCode xsi:type="ns2:string">RG2 6GE</postCode>
               </recipientAddress>
               <recipientCode xsi:type="ns2:string">READING1</recipientCode>
               <recipientName xsi:type="ns2:string">READING WAREHOUSE</recipientName>
               <returnAddress xsi:type="ns3:Address">
               <companyName xsi:type="ns2:string">CHEZ WALTER WHITE</companyName>
                  <countryCode xsi:type="ns2:string">FR</countryCode>
                  <line1 xsi:type="ns2:string">La Maison Blanche</line1>
                  <line2 xsi:type="ns2:string">33 Rue des Lapins</line2>
                  <line3 xsi:type="ns2:string">PARIS</line3>
                  <postCode xsi:type="ns2:string">75005</postCode>
               </returnAddress>
               <returnName xsi:type="soapenc:string">M. Walter White</returnName>
               <senderAddress xsi:type="ns3:Address">
                  <countryCode xsi:type="ns2:string">FR</countryCode>
                  <line1 xsi:type="ns2:string">La Maison Blanche</line1>
                  <line2 xsi:type="ns2:string">33 Rue des Lapins</line2>
                  <line3 xsi:type="ns2:string">PARIS</line3>
                  <postCode xsi:type="ns2:string">75005</postCode>
               </senderAddress>
               <senderEmail xsi:type="ns2:string">walterwhite@lamaisonblanche.fr</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">RMTRACKEDSTDNOSIGRTN</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>
            <Property>
               <propertyName>dpi</propertyName>
               <propertyValue>203.8</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">300.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/">000002307</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" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
               <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/">DMC4BY1WG9E6</consignmentCode>
               <consignmentLevelDetailsFlag xsi:type="xsd:boolean">false</consignmentLevelDetailsFlag>
               <consignmentValue xsi:type="xsd:double">300.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">true</customsDocumentationRequired>
               <cutOffDate xsi:type="xsd:dateTime">2021-01-15T22:00:00.000Z</cutOffDate>
               <despatchDate xsi:type="xsd:dateTime">2021-01-16T07:00:00.000Z</despatchDate>
               <earliestDeliveryDate xsi:type="xsd:dateTime">2021-01-18T06: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">2021-01-20T17: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/">fr</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">2021-01-12T10:17:49.000Z</orderDate>
               <orderNumber xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">SR6001085136PICKUP</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" xsi:nil="true"/>
                     <code xsi:type="soapenc:string">000002307</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">300.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">300.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">000002307</trackingCode>
                     <trackingUrl xsi:type="soapenc:string" xsi:nil="true"/>
                  </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[18]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
                  <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">route.collection.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field20</propertyName>
                     <propertyValue xsi:type="soapenc:string">3a6876c3-afad-4382-b156-127318f60731</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 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.collection.level2</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">carrier.manifest.areas</propertyName>
                     <propertyValue xsi:type="soapenc:string">0,0,0</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">allocation.bookingcode</propertyName>
                     <propertyValue xsi:type="soapenc:string">RMTRACKEDSTDNOSIGRTN</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level5</propertyName>
                     <propertyValue xsi:type="soapenc:string">___________</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level4</propertyName>
                     <propertyValue xsi:type="soapenc:string">__</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level3</propertyName>
                     <propertyValue xsi:type="soapenc:string">__</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level2</propertyName>
                     <propertyValue xsi:type="soapenc:string">__</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.level1</propertyName>
                     <propertyValue xsi:type="soapenc:string">__</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"/>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">carrier.field1</propertyName>
                     <propertyValue xsi:type="soapenc:string">222</propertyValue>
                  </properties>
                  <properties xsi:type="ns2:Property">
                     <propertyName xsi:type="soapenc:string">route.version</propertyName>
                     <propertyValue xsi:type="soapenc:string">20201001</propertyValue>
                  </properties>
               </properties>
               <recipientAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING WAREHOUSE</companyName>
                  <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/">900 LONGWATER AVENUE</line1>
                  <line2 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING</line2>
                  <line3 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">BERKSHIRE</line3>
                  <line4 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <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/">READING WAREHOUSE</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" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">CHEZ WALTER WHITE</companyName>
                  <countryCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">FRA</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/">La Maison Blanche</line1>
                  <line2 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">33 Rue des Lapins</line2>
                  <line3 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">PARIS</line3>
                  <line4 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <postCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">75005</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/">M. 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/">FRA</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/">La Maison Blanche</line1>
                  <line2 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">33 Rue des Lapins</line2>
                  <line3 xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">PARIS</line3>
                  <line4 xsi:type="soapenc:string" xsi:nil="true" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
                  <postCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">75005</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@lamaisonblanche.fr</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/Paris</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" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">JVBERi0x...</documents>
               <labels xsi:type="soapenc:base64Binary" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">JVBERi0x...</labels>
           </paperwork>
         </despatchConsignmentWithBookingCodeReturn>
      </ns1:despatchConsignmentWithBookingCodeResponse>
   </soapenv:Body>

Decoding and printing the labels and customs documents

The documentation results are generated in the labels and documents elements within the paperwork at the end of the response.

The labels element contains an encoded string for each parcel label, and the documents element contains an encoded string for the customs documents.

Note

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.

The label for the above example is decoded as follows.

The customs document for the above example is decoded as follows.

You can now send the paperwork to the recipient so that it can be attached to the return ahead of the carrier collection.

Collecting return from recipient

Note

Depending on the returns experience that you want to offer, this step might be optional.

We will add our collection to a "returns" manifest group and then schedule the collections in the manifest group for future pickup.

Adding the collection to a manifest group

Complete the following steps:

If you have not already done so, open a new project using the WSDL ConsignmentService.xml.
Create a new request under addConsignmentsToGroup,
Enter the authorisation for the request.
Specify the following:
- The code of our newly created return consignment.
- The manifest group code to be added (PICKUP_TRUCK in this case).
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:addConsignmentsToGroup soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
        <consignmentCodes xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ser:ArrayOf_soapenc_string" soapenc:arrayType="soapenc:string[]">
            <item>DMC4BY1WG9E6</item>
         </consignmentCodes>
         <manifestGroupCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">PICKUP_TRUCK</manifestGroupCode>
      </ser:addConsignmentsToGroup>
   </soapenv:Body>
</soapenv:Envelope>

Example response

If the input is valid, the consignment is assigned to the PICKUP_TRUCK manifest group, and true is returned.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <ns1:addConsignmentsToGroupResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <addConsignmentsToGroupReturn xsi:type="xsd:boolean">true</addConsignmentsToGroupReturn>
      </ns1:addConsignmentsToGroupResponse>
   </soapenv:Body>
</soapenv:Envelope>

Scheduling the manifest group for future pickup

To schedule our consignment (and all the others in the PICKUP_TRUCK manifest group) for pickup at a future date:

If you have not already done so, open a new project using the WSDL ManifestService.xml.
Create a new request under createManifestForFutureDespatch,
Enter the authorisation for the request.
Specify the following to filter the consignments that are 'Ready to manifest':
- The carrier code (refer to findCarriers).
- The warehouse code.
- A transactionType of Pick-up.
- The manifest group that you created previously.
Specify the future despatchDate.
Set specificDateOnly to true if only those consignments that are due to be collected on the specified despatchDate are to be added to the manifest.

Otherwise, set it to false.
Click to submit the request.

Example response

<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:createManifestForFutureDespatch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <carrierCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">ROYALMAILTRKNOOBA</carrierCode>
         <warehouseCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">READING1</warehouseCode>
         <transactionType xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">Pick-up</transactionType>
         <manifestGroupCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">PICKUP_TRUCK</manifestGroupCode>
         <despatchDate xsi:type="xsd:dateTime">2021-01-18T08:00:00.000Z</despatchDate>
         <specificDateOnly xsi:type="xsd:boolean">TRUE</specificDateOnly>
      </ser:createManifestForFutureDespatch>
   </soapenv:Body>
</soapenv:Envelope>

Example response

As shown below, if the input is valid, a manifest number is returned and the newly created manifest is emailed to the carrier.

<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:createManifestForFutureDespatchResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <createManifestForFutureDespatchReturn soapenc:arrayType="soapenc:string[1]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <createManifestForFutureDespatchReturn xsi:type="soapenc:string">DMM1W29ZV</createManifestForFutureDespatchReturn>
         </createManifestForFutureDespatchReturn>
      </ns1:createManifestForFutureDespatchResponse>
   </soapenv:Body>
</soapenv:Envelope>