PieceDefinition structure
A structure describing the physical parameters of parcels. It is used in the createShipment method.
Structure Fields
| Field Name | Type | Required? | Description |
|---|---|---|---|
| type | string | Yes | One of the values: "ENVELOPE", "PACKAGE", "PALLET" |
| width | integer | No | Width in centimetres, required if the type is other than "ENVELOPE" |
| height | integer | No | Height in centimetres, required if the type is other than "ENVELOPE" |
| length | integer | No | Length in centimetres, required if the type is other than "ENVELOPE" |
| weight | integer | No | Weight in kilograms, required if the type is other than "ENVELOPE" |
| quantity | integer | Yes | Quantity of parcels |
| nonStandard | boolean | No | Is the parcel non-standard (according to the price list definition) |
| euroReturn | boolean | No | Are euro pallets to be returned (only selectable with type = “PALLET”) |
| blpPieceId | string | No | BLP identifier - for customers printing labels of this type, with their own parcel numbering |
Example:
<pieceDefinition> <type>PACKAGE</type> <width>80</width> <height>40</height> <length>40</length> <weight>15</weight> <quantity>1</quantity> <nonStandard>true</nonStandard> </pieceDefinition>