This array hold details of each itemised parcel specified in the parcel count, with each parcel having the following properties:
Table 16. Parcels Array Properties
Property Name |
Type |
Manda- tory? |
Description |
---|---|---|---|
|
|
The Cash on Delivery amount for the parcel. |
|
|
|
The carton ID supplied by the OMS/WMS. Paperwork can be generated for each |
|
|
|
||
|
|
The parcel destination reference. |
|
|
|
The amount (in GBP) of duty paid. |
|
|
|
The index number of the parcel within the consignment, for example, parcel 2 of 3 (read only). |
|
|
|
The code of the parcel's outer (parent) consignment. |
|
|
|
The parcel number of the parcel's outer (parent) consignment. |
|
|
|
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?). |
|
|
|
The height of the parcel. The units default to centimetres if Imperial units are not set. |
|
|
|
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 |
|
|
|
The value of the parcel (in GBP). |
|
|
|
The weight of the parcel. The units default to kilograms if Imperial units are not set. If the |
|
|
|
The width of the parcel. The units default to centimetres if Imperial units are not set. |
|
|
array of type |
Array holding details of each of the products being shipped. |
|
|
|
The reference of the parcel recipient. |
|
|
|
Any additional reference. |
|
|
|
The reference of the parcel sender, for example, warehouse. |
|
|
|
The parcel tracking code (Read only) |
|
|
|
The URL (if appropriate) on the carrier's tracking site (Read only). |
|
|
|
Code referencing the specific type of packaging. |
|
|
|
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.