Metoda grupująca deleteShipment
Przy pomocy tej metody możliwe jest - w jednym żądaniu - anulowanie kuriera i usunięcie przesyłki.
Parametry wejściowe
Nazwa pola | Typ | Wymagane? | Opis |
---|---|---|---|
authData | AuthData | Tak | Struktura autoryzacyjna |
shipmentIdentificationNumber | string | Tak | Numer przesyłki, która ma zostać usunięta |
dispatchIdentificationNumber | string | Tak | Identyfikator zamówienia kuriera do anulowania |
Parametry wyjściowe
Nazwa pola | Typ | Wymagane? | Opis |
---|---|---|---|
id | string | - | Identyfikator przesyłki |
result | bool | - | Wynik: true - pomyślne usunięcie, false - przesyłka nie usunięta |
error | string | - | Treść błędu, wypełniona tylko, gdy result = false |
Przykłady wywołania
Żądanie usunięcia przesyłki o identyfikatorze 11102224567:
<authData> <username>testomir</username> <password>testalski</password> </authData> <shipment> <shipmentIdentificationNumber>11102224567</shipmentIdentificationNumber> </shipment>
Jeśli po powyższą przesyłkę zamówiony jest kurier, jej usunięcie będzie niemożliwe (o czym informować będzie komunikat zwrotny). W takim przypadku należy wysłać żądanie podając również numer zamówienia kuriera:
<authData> <username>testomir</username> <password>testalski</password> </authData> <shipment> <shipmentIdentificationNumber>11102224567</shipmentIdentificationNumber> <dispatchIdentificationNumber>91012WWW</dispatchIdentificationNumber> </shipment>