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

debugConsignmentWhyNot

This method returns, for any given consignment, the carrier services that cannot be selected for allocation, and the reasons.

Tip

If you need to modify your carrier services after using this method, refer to Configuring your Carrier Services.

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

How to submit a request

Proceed as follows:

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

  2. Create a new request under debugConsignmentWhyNot,

  3. Enter the authorisation for the request.

  4. Define the advanced allocation filter.

    Note

    If you omit the advanced allocation filter (by removing the entire <filter>...</filter> tag), then the default allocation filter will be assumed, which means that the allocation will be attempted in accordance with the following hierarchy:

    1. Prioritised service (if one has been selected automatically via the Carrier Allocation Rules).

    2. Shipping cost (the system will always try and select the cheapest service where there is no prioritised service).

    3. Earliest despatch (if two services cost the same, the one that leaves the warehouse first will be chosen).

    4. Earliest delivery (if two services cost the same and leave the warehouse at the same time, the one that can deliver first is selected),

  5. Click Arrow.png to submit the request. If any carrier services are not available, then they are returned in the debugConsignmentWhyNotReturn array (refer to the Example Response below).

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:debugConsignmentWhyNot soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <consignmentCode xsi:type="soapenc:string" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">DMC4BY1U60TX</consignmentCode>
         <filter xsi:type="typ:AllocationFilter" xmlns:typ="urn:DeliveryManager/types">
            <acceptableDeliveryDays xsi:type="typ:WorkingDays">
               <friday xsi:type="xsd:boolean">true</friday>
               <monday xsi:type="xsd:boolean">true</monday>
               <saturday xsi:type="xsd:boolean">false</saturday>
               <sunday xsi:type="xsd:boolean">false</sunday>
               <thursday xsi:type="xsd:boolean">true</thursday>
               <tuesday xsi:type="xsd:boolean">true</tuesday>
               <wednesday xsi:type="xsd:boolean">true</wednesday>
            </acceptableDeliveryDays>
         </filter>
      </ser:debugConsignmentWhyNot>
   </soapenv:Body>
</soapenv:Envelope>

For an example response, 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:debugConsignmentWhyNotResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:DeliveryManager/services">
         <debugConsignmentWhyNotReturn soapenc:arrayType="soapenc:string[27]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">HERM48 cannot be used as there is a parcel where the dimensions PF_GIRTH  (PF_GIRTH=(D1+D2)*2+D3 where D1&amp;#60;D2&amp;#60;D3) is too long</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">HERMNONSIG48 cannot be used as there is a parcel where the dimensions PF_GIRTH  (PF_GIRTH=(D1+D2)*2+D3 where D1&amp;#60;D2&amp;#60;D3) is too long</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">HERMNDG cannot be used as there is a parcel where the dimensions PF_GIRTH  (PF_GIRTH=(D1+D2)*2+D3 where D1&amp;#60;D2&amp;#60;D3) is too long</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-06 18:30:00-2020-06-06 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07NEXTDAY rejected as possible collection slots are not acceptable 2020-06-06 18:30:00-2020-06-06 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-07 18:30:00-2020-06-07 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07NEXTDAY rejected as possible collection slots are not acceptable 2020-06-07 18:30:00-2020-06-07 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-13 18:30:00-2020-06-13 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07NEXTDAY rejected as possible collection slots are not acceptable 2020-06-13 18:30:00-2020-06-13 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-14 18:30:00-2020-06-14 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07NEXTDAY rejected as possible collection slots are not acceptable 2020-06-14 18:30:00-2020-06-14 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-20 18:30:00-2020-06-20 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07NEXTDAY rejected as possible collection slots are not acceptable 2020-06-20 18:30:00-2020-06-20 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-21 18:30:00-2020-06-21 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07NEXTDAY rejected as possible collection slots are not acceptable 2020-06-21 18:30:00-2020-06-21 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-06 15:30:00-2020-06-06 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07SWAPIT2D rejected as possible collection slots are not acceptable 2020-06-06 15:30:00-2020-06-06 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-07 15:30:00-2020-06-07 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07SWAPIT2D rejected as possible collection slots are not acceptable 2020-06-07 15:30:00-2020-06-07 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-13 15:30:00-2020-06-13 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07SWAPIT2D rejected as possible collection slots are not acceptable 2020-06-13 15:30:00-2020-06-13 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-14 15:30:00-2020-06-14 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07SWAPIT2D rejected as possible collection slots are not acceptable 2020-06-14 15:30:00-2020-06-14 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-20 15:30:00-2020-06-20 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07SWAPIT2D rejected as possible collection slots are not acceptable 2020-06-20 15:30:00-2020-06-20 19:30:59</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">2020-06-21 15:30:00-2020-06-21 19:30:59 cannot be used as a collection slot as it includes a warehouse non-working day</debugConsignmentWhyNotReturn>
            <debugConsignmentWhyNotReturn xsi:type="soapenc:string">DPD07SWAPIT2D rejected as possible collection slots are not acceptable 2020-06-21 15:30:00-2020-06-21 19:30:59</debugConsignmentWhyNotReturn>
         </debugConsignmentWhyNotReturn>
      </ns1:debugConsignmentWhyNotResponse>
   </soapenv:Body>
</soapenv:Envelope>