FindDeliveryOptionsParams
This object contains the parameters available for filtering delivery options.
Parameters:
| Parameter | Type | Default | Description | |
|---|---|---|---|---|
| 1 | consignmentWeight | Double | 0 | The total weight (in KG) of the consignment. |
| 2 | hazardous | Boolean | False | Flag indicating whether or not the consignment contains hazardous materials. |
| 3 | liquid | Boolean | False | Flag indicating whether or not the consignment contains liquids. |
| 4 | maximumDimension | Double | 0 | The length of the longest side of the longest parcel (in CM). |
| 5 | parcelCount | Integer | 1 | The number of parcels in the consignment. |
| 6 | recipientAddress | Address | - | The address of the recipient. |
| 7 | senderAddress | Address | - | The address of the sender. |
| 8 | serviceTypeName | String | - | Limit delivery options to the specified service type. By default, all service types will be considered. |
| 9 | transactionType | String | delivery | The type of transaction. This is either delivery or pick-up |
| 10 | twoManLiftRequired | Boolean | False | Flag indicating whether or not the consignment requires two people to lift it. |
| 11 | warehouseCode | String | - | The code of the warehouse. |
