DeleteShipment Grouping Method
Using this method, you can delete a shipment and cancel a courier collection in one request.
Input Parameters
| Field Name | Type | Required? | Description |
|---|---|---|---|
| authData | AuthData | Yes | Authorisation structure |
| shipmentIdentificationNumber | string | Yes | Shipment number of the shipment to be deleted |
| dispatchIdentificationNumber | string | Yes | ID of the courier order to be cancelled |
Output Parameters
| Field Name | Type | Required? | Description |
|---|---|---|---|
| id | string | - | Parcel ID |
| result | bool | - | Results: true - successful deletion, false - shipment not deleted |
| error | string | - | Error content filled only when result = false |
Examples of calls
Request for deletion of the shipment with the ID number 11102224567:
<authData> <username>testan</username> <password>testington</password> </authData> <shipment> <shipmentIdentificationNumber>11102224567</shipmentIdentificationNumber> </shipment>
If a courier is ordered to collect the above parcel, it will not be possible to delete it (this will be communicated with a return message). In this case, please send a request stating also the courier order number.
<authData> <username>testan</username> <password>testington</password> </authData> <shipment> <shipmentIdentificationNumber>11102224567</shipmentIdentificationNumber> <dispatchIdentificationNumber>91012WWW</dispatchIdentificationNumber> </shipment>