Parcels Array

This array hold details of each itemised parcel specified in the parcel count, with each parcel having the following properties:

Table 2. Parcels Array Properties

Property Name

Type

Manda- tory?

Description

CODParcelAmount

double precision floating point number

The Cash on Delivery amount for the parcel.

cartonId

string

The carton ID supplied by the OMS/WMS.

Paperwork can be generated for each cartonId (refer to createPaperworkForCarton).

code

string

The barcode for the parcel (Read only).

destinationReference

string

The parcel destination reference.

dutyPaid

double precision floating point number

The amount (in GBP) of duty paid.

number

integer

The index number of the parcel within the consignment, e.g. parcel 2 of 3 (Read only).

outerConsignmentCode

string

The code of the parcel's parent consignment.

outerParcelNumber

integer

The parcel number of the parcel's parent.

parcelDepth

double precision floating point number

The depth of the parcel. The units default to centimetres if Imperial units are not set (refer to How do I create consignments in Imperial Weights and Measures?).

parcelHeight

double precision floating point number

The height of the parcel. The units default to centimetres if Imperial units are not set.

parcelNumber or parcelNo

integer

The sequence number of the parcel within the consignment.

This is a Read only field that is automatically generated. However, you need to specify the value when using createPaperworkForParcel or packProductsToParcel (where the property is parcelNumber), or deleteParcelFromConsignment (where the property is parcelNo).

parcelValue

double precision floating point number

The value of the parcel (in GBP).

parcelWeight

double precision floating point number

The weight of the parcel. The units default to kilograms if Imperial units are not set.

If the consignmentLevelDetailsFlag is set to false, then parcelWeight is mandatory.

parcelWidth

double precision floating point number

The width of the parcel. The units default to centimetres if Imperial units are not set.

products

array of type product

Array holding details of each of the products being shipped.

recipientReference

string

The reference of the parcel recipient.

reference

string

Any additional reference.

senderReference

string

The reference of the parcel sender (e.g. warehouse).

trackingCode

string

The parcel tracking code (Read only)

trackingUrl

string

The URL (if appropriate) on the carrier's tracking site (Read only).

packageTypeCode

string

Code referencing the specific type of packaging (Read only).

parcelPrintStatus

string

The print status of the parcel (Read only).


For example:

...
<consignments xsi:type="soapenc:Array" soapenc:arrayType="tns1:Consignment[1]">
      <item xsi:type="tns1:Consignment">
      ...
          <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">
                               ...                                  
                               </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>
                        ...
       </item>
  </consignments>
...

Each parcel can contain one or more product arrays.