How do I create consignments in Imperial Weights and Measures?

If you are contracted to ship consignments in Imperial units, then you should use the measurementUnits type in the consignments array to set the units for individual consignments.

This type allows you to specify the units for one or more of the following properties: length, weight, and volume. For example:

 <measurementUnits xsi:type="ns2:MeasurementUnits">
         <length>in</length>
         <weight>lb</weight>
         <volume>oz</volume>
 </measurementUnits>

If you are a new Metapack customer and you wish to ship in Imperial units on a regular basis, you should contact Metapack Support so that the relevant system property (measurement-system.name) can be added to your Retailer account and set to IMPERIAL.

Caution

This will have the effect shown below for all consignments, not just those added via the measurementUnits type in the consignments array.

Note

If you only use Metric units with either the API or GUI, then, because METRIC is the default throughout Delivery Manager, there is no need for either the measurementUnits API type or the measurement-system.name system property to be set.

Table 26. measurementUnits Properties

Parameter

Type

Manda- tory?

Description

length

string

The length unit of measurement to be supplied to Delivery Manager for the current consignment (the same measurement will be used in the consignment's parcels and products).

The possible values are 'cm' (centimetres) or 'in' (inches).

weight

string

The weight unit of measurement to be supplied to Delivery Manager for the current consignment (the same measurement will be used in the consignment's parcels and products).

The possible values are 'kg' (kilograms) or 'lb' (pounds).

volume

string

The volume unit of measurement to be supplied to Delivery Manager for the current consignment (the same measurement will be used in the consignment's parcels and products).

The possible values are 'ml' (millilitres) or 'oz' (ounces).

After setting the types of units, you set one or more of the following numeric values for each parcel in the Parcels Array: the parcelDepth, parcelHeight, parcelWeight and parcelWidth, e.g.

<parcelDepth xsi:type="xsd:double">1.0</parcelDepth>
<parcelHeight xsi:type="xsd:double">2.0</parcelHeight>
<parcelWeight xsi:type="xsd:double">2.0</parcelWeight>
<parcelWidth xsi:type="xsd:double">3.2</parcelWidth>

Following creation of the consignment, you will see the values in the Details tab of the GUI.

Example: Creating a consignment using the Imperial `measurementUnits` properties

The following example shows you how to create a consignment that is measured in Imperial units, using the Shipping API method despatchConsignmentWithBookingCode:

<?xml version="1.0" encoding="UTF-8"?>
<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">
               <measurementUnits xsi:type="ns2:MeasurementUnits">
               <length>in</length>
               <weight>lb</weight>
               <volume>oz</volume>
               </measurementUnits>
                <CODAmount xsi:type="xsd:double">0</CODAmount>
                      <CODFlag xsi:type="xsd:boolean">false</CODFlag>
                      <CODPaymentTypeCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <CODSpecialInstruction xsi:type="soapenc:string" xsi:nil="true"/>
                      <CODSurcharge xsi:type="xsd:double">0</CODSurcharge>
                      <alreadyPalletisedGoodsFlag xsi:type="xsd:boolean">false</alreadyPalletisedGoodsFlag>
                      <cardNumber xsi:type="soapenc:string" xsi:nil="true"/>
                      <carrierCode xsi:type="soapenc:string" xsi:nil="true"/>
                     <carrierConsignmentCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <carrierName xsi:type="soapenc:string" xsi:nil="true"/>
                      <carrierServiceCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <carrierServiceName xsi:type="soapenc:string" xsi:nil="true"/>
                      <carrierServiceVATRate xsi:type="xsd:double">0.0</carrierServiceVATRate>
                      <cartonNumber xsi:type="soapenc:string" xsi:nil="true"/>
                      <cashOnDeliveryCurrency xsi:type="soapenc:string">GBP</cashOnDeliveryCurrency>
                      <committedCollectionWindow xsi:type="ns2:DateRange" xsi:nil="true"/>
                      <committedDeliveryWindow xsi:type="ns2:DateRange" xsi:nil="true"/>
                      <consDestinationReference xsi:type="soapenc:string" xsi:nil="true"/>
                      <consOriginReference xsi:type="soapenc:string" xsi:nil="true"/>
                      <consRecipientReference xsi:type="soapenc:string" xsi:nil="true"/>
                      <consReference xsi:type="soapenc:string" xsi:nil="true"/>
                      <consSenderReference xsi:type="soapenc:string" xsi:nil="true"/>
                      <consignmentCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <consignmentLevelDetailsFlag xsi:type="xsd:boolean">false</consignmentLevelDetailsFlag>
                      <consignmentValue xsi:type="xsd:double">30</consignmentValue>
                      <consignmentValueCurrencyCode xsi:type="soapenc:string">GBP</consignmentValueCurrencyCode>
                      <consignmentValueCurrencyRate xsi:type="xsd:double">0.0</consignmentValueCurrencyRate>
                      <consignmentWeight xsi:type="xsd:double">2</consignmentWeight>
                      <custom1 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom10 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom2 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom3 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom4 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom5 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom6 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom7 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom8 xsi:type="soapenc:string" xsi:nil="true"/>
                      <custom9 xsi:type="soapenc:string" xsi:nil="true"/>
                      <customsDocumentationRequired xsi:type="xsd:boolean">false</customsDocumentationRequired>
                      <cutOffDate xsi:type="xsd:dateTime" xsi:nil="true"/>
                      <despatchDate xsi:type="xsd:dateTime" xsi:nil="true"/>
                      <earliestDeliveryDate xsi:type="xsd:dateTime" xsi:nil="true"/>
                      <endVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
                      <fragileGoodsFlag xsi:type="xsd:boolean">false</fragileGoodsFlag>
                      <guaranteedDeliveryDate xsi:type="xsd:dateTime" xsi:nil="true"/>
                      <hazardousGoodsFlag xsi:type="xsd:boolean">false</hazardousGoodsFlag>
                      <insuranceValue xsi:type="xsd:double">0.0</insuranceValue>
                      <insuranceValueCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <insuranceValueCurrencyRate xsi:type="xsd:double">0.0</insuranceValueCurrencyRate>
                      <languageCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <liquidGoodsFlag xsi:type="xsd:boolean">false</liquidGoodsFlag>
                      <manifestGroupCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <maxDimension xsi:type="xsd:double">0</maxDimension>
                      <metaCampaignKey xsi:type="soapenc:string" xsi:nil="true"/>
                      <metaCustomerKey xsi:type="soapenc:string" xsi:nil="true"/>
                      <moreThanOneMetreGoodsFlag xsi:type="xsd:boolean">false</moreThanOneMetreGoodsFlag>
                      <moreThanTwentyFiveKgGoodsFlag xsi:type="xsd:boolean">false</moreThanTwentyFiveKgGoodsFlag>
                      <orderDate xsi:type="xsd:dateTime" xsi:nil="true"/>
                      <orderNumber xsi:type="soapenc:string">T4RE345A</orderNumber>
                      <orderValue xsi:type="xsd:double">100</orderValue>
                      <parcelCount xsi:type="xsd:int">2</parcelCount>
                      <parcels soapenc:arrayType="ns2:Parcel[1]" xsi:type="soapenc:Array">
                         <parcels xsi:type="ns2:Parcel">
                            <cartonId xsi:type="soapenc:string">08K02JTY8</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">1.0</parcelDepth>
                            <parcelHeight xsi:type="xsd:double">2.0</parcelHeight>
                            <parcelValue xsi:type="xsd:double">20</parcelValue>
                            <parcelWeight xsi:type="xsd:double">2.0</parcelWeight>
                            <parcelWidth xsi:type="xsd:double">3.2</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">15</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" xsi:nil="true"/>
                            <trackingUrl xsi:type="soapenc:string" xsi:nil="true"/>
                         </parcels>
                         <parcels xsi:type="ns2:Parcel">
                            <cartonId xsi:type="soapenc:string">08K02JTY8</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">1.0</parcelDepth>
                            <parcelHeight xsi:type="xsd:double">2.0</parcelHeight>
                            <parcelValue xsi:type="xsd:double">20</parcelValue>
                            <parcelWeight xsi:type="xsd:double">2.0</parcelWeight>
                            <parcelWidth xsi:type="xsd:double">3.2</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">15</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" xsi:nil="true"/>
                            <trackingUrl xsi:type="soapenc:string" xsi:nil="true"/>
                         </parcels>
                      </parcels>
                      <pickTicketNumber xsi:type="soapenc:string" xsi:nil="true"/>
                      <pickupPoint xsi:type="soapenc:string" xsi:nil="true"/>
                      <podRequired xsi:type="soapenc:string">any</podRequired>
                      <properties soapenc:arrayType="ns2:Property[0]" xsi:type="soapenc:Array"/>
                      <recipientAddress xsi:type="ns2:Address">
                         <companyName xsi:type="soapenc:string" xsi:nil="true"/>
                         <countryCode xsi:type="soapenc:string">GBR</countryCode>
                         <floor xsi:type="soapenc:string" xsi:nil="true"/>
                         <line1 xsi:type="soapenc:string">MetaPack</line1>
                         <line2 xsi:type="soapenc:string">12-16 Laystall St</line2>
                         <line3 xsi:type="soapenc:string">London</line3>
                         <line4 xsi:type="soapenc:string" xsi:nil="true"/>
                         <postCode xsi:type="soapenc:string">SE19 3HG</postCode>
                         <region xsi:type="soapenc:string" xsi:nil="true"/>
                         <streetName xsi:type="soapenc:string" xsi:nil="true"/>
                         <streetNo xsi:type="soapenc:string" xsi:nil="true"/>
                         <streetType xsi:type="soapenc:string" xsi:nil="true"/>
                         <town xsi:type="soapenc:string" xsi:nil="true"/>
                         <type xsi:type="soapenc:string" xsi:nil="true"/>
                      </recipientAddress>
                      <recipientCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <recipientContactPhone xsi:type="soapenc:string">0207 843 6832</recipientContactPhone>
                      <recipientEmail xsi:type="soapenc:string">peter.mcgee@metapack.com</recipientEmail>
                      <recipientMobilePhone xsi:type="soapenc:string">01211554975</recipientMobilePhone>
                      <recipientName xsi:type="soapenc:string">Peter McGee</recipientName>
                      <recipientNotificationType xsi:type="soapenc:string">N</recipientNotificationType>
                      <recipientPhone xsi:type="soapenc:string">0207 843 6832</recipientPhone>
                      <recipientTimeZone xsi:type="soapenc:string">Europe/London</recipientTimeZone>
                      <recipientVatNumber xsi:type="soapenc:string">123456789</recipientVatNumber>
                      <returnAddress xsi:type="ns2:Address">
                         <companyName xsi:type="soapenc:string" xsi:nil="true"/>
                         <countryCode xsi:type="soapenc:string" xsi:nil="true"/>
                         <floor xsi:type="soapenc:string" xsi:nil="true"/>
                         <line1 xsi:type="soapenc:string" xsi:nil="true"/>
                         <line2 xsi:type="soapenc:string" xsi:nil="true"/>
                         <line3 xsi:type="soapenc:string" xsi:nil="true"/>
                         <line4 xsi:type="soapenc:string" xsi:nil="true"/>
                         <postCode xsi:type="soapenc:string" xsi:nil="true"/>
                         <region xsi:type="soapenc:string" xsi:nil="true"/>
                         <streetName xsi:type="soapenc:string" xsi:nil="true"/>
                         <streetNo xsi:type="soapenc:string" xsi:nil="true"/>
                         <streetType xsi:type="soapenc:string" xsi:nil="true"/>
                         <town xsi:type="soapenc:string" xsi:nil="true"/>
                         <type xsi:type="soapenc:string" xsi:nil="true"/>
                      </returnAddress>
                       <senderAddress xsi:type="ns2:Address">
                  <companyName xsi:type="soapenc:string">Default</companyName>
                  <countryCode xsi:type="soapenc:string">GBR</countryCode>
                  <floor xsi:type="soapenc:string" xsi:nil="true"/>
                  <line1 xsi:type="soapenc:string">Line 1</line1>
                  <line2 xsi:type="soapenc:string">Line2</line2>
                  <line3 xsi:type="soapenc:string">Line3`</line3>
                  <line4 xsi:type="soapenc:string">Line4</line4>
                  <postCode xsi:type="soapenc:string">ME11JT</postCode>
                  <region xsi:type="soapenc:string" xsi:nil="true">HR region</region>
                  <streetName xsi:type="soapenc:string" xsi:nil="true">Laystall Street</streetName>
                  <streetNo xsi:type="soapenc:string" xsi:nil="true">12-16</streetNo>
                  <streetType xsi:type="soapenc:string" xsi:nil="true">Business</streetType>
                  <town xsi:type="soapenc:string" xsi:nil="true">Eltham</town>
                  <type xsi:type="soapenc:string">Business</type>
               </senderAddress>
               <senderCode xsi:type="soapenc:string">READING1</senderCode>
               <senderContactPhone xsi:type="soapenc:string">21323545</senderContactPhone>
               <senderEmail xsi:type="soapenc:string">sandra.demenezes@metapack.com</senderEmail>
                      <senderName xsi:type="soapenc:string">Westcoast</senderName>
                      <senderNotificationType xsi:type="soapenc:string" xsi:nil="true"/>
                      <senderPhone xsi:type="soapenc:string" xsi:nil="true"/>
                      <senderTimeZone xsi:type="soapenc:string">Europe/London</senderTimeZone>
                      <startVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
                      <shipmentTypeCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <shippingAccount xsi:type="soapenc:string" xsi:nil="true"/>
                      <shippingCharge xsi:type="xsd:double">0.0</shippingCharge>
                      <shippingChargeCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <shippingChargeCurrencyRate xsi:type="xsd:double">0.0</shippingChargeCurrencyRate>
                      <shippingCost xsi:type="xsd:double">0.0</shippingCost>
                      <shippingCostCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <shippingCostCurrencyRate xsi:type="xsd:double">0.0</shippingCostCurrencyRate>
                      <signatoryOnCustoms xsi:type="soapenc:string"/>
                      <specialInstructions1 xsi:type="soapenc:string">Leave in recycling box</specialInstructions1>
                      <specialInstructions2 xsi:type="soapenc:string" xsi:nil="true"/>
                      <startVatNumber xsi:type="soapenc:string" xsi:nil="true"/>
                      <status xsi:type="soapenc:string" xsi:nil="true"/>
                      <taxAndDuty xsi:type="xsd:double">0.0</taxAndDuty>
                      <taxAndDutyCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <taxAndDutyCurrencyRate xsi:type="xsd:double">0.0</taxAndDutyCurrencyRate>
                      <taxAndDutyStatusText xsi:type="soapenc:string" xsi:nil="true"/>
                      <taxDutyDeclarationCurrencyCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <termsOfTradeCode xsi:type="soapenc:string" xsi:nil="true"/>
                      <transactionType xsi:type="soapenc:string">Delivery</transactionType>
                      <twoManLiftFlag xsi:type="xsd:boolean">false</twoManLiftFlag>
               </consignment>
         <bookingCode xsi:type="soapenc:string">@NEXT</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>

Results of displaying a consignment in Imperial units

When you open the resulting 'Ready to manifest' consignment in the GUI and look under the Details tab, you will see the parcel information displayed using Imperial weights and measures, e.g.

Note

When you hover over an Imperial field with the mouse, its Metric equivalent is displayed.

Caution

Note

Example: Creating a consignment using the Imperial measurementUnits properties

Results of displaying a consignment in Imperial units

Note

Example: Creating a consignment using the Imperial `measurementUnits` properties