Przejdź do głównej treści
DELETE
Anuluj zlecenie przesyłki. Wywołuje API dostawcy logistycznego w celu anulowania zlecenia i zmienia status przesyłki na cancelled. Anulowanie przesyłki, która ma już status cancelled, zwraca 200 z tą przesyłką, a dostawca jest wywoływany tylko raz. Odpowiedź zawiera Idempotent-Replayed: true, dzięki czemu odróżnisz powtórzenie od wywołania, które faktycznie wykonało operację. Zobacz Idempotencja.
Przesyłek nie można anulować po odbiorze — takie żądanie zwraca 409 Conflict.
Etykiety zwrotnej DHL nie można anulować osobno; to również zwraca 409 Conflict. Zamiast tego anuluj paczkę wychodzącą. Anulowanie wychodzącej paczki DHL anuluje też jej wiersze zwrotne o statusie pending. Każdy z nich dostaje status cancelled z wpisem RETURN_LEG_CANCELLED w status_updates. Zobacz Etykiety zwrotne. W pudełku z kilkoma zestawami każdy zestaw ma własny wiersz wychodzący i własną etykietę zwrotną, nawet gdy pudełko jest wysyłane na etykiecie jednego z zestawów. Anulowanie wiersza wychodzącego danego zestawu anuluje też jego etykietę zwrotną. Aby anulować paczkę z zestawem domowym, każde powiązane zamówienie zestawu domowego musi znajdować się w twoim kontekście dostępu. W przeciwnym razie żądanie zwraca 403. Zobacz Dostęp.

Żądanie

Parametry ścieżki

string
wymagane
Identyfikator referencyjny przesyłki (np. P2611194821).

Odpowiedź

W przypadku powodzenia API zwraca 200 OK wraz z obiektem anulowanej przesyłki.
string
wymagane
Identyfikator referencyjny przesyłki.
string
wymagane
Status cyklu życia przesyłki. Po pomyślnym anulowaniu będzie miał wartość cancelled.
string
wymagane
Dostawca logistyczny. Jedna z wartości: go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups lub dhl_express. Paczka z zestawem domowym ma wartość dhl_parcel albo dhl_warenpost, gdy jest wysyłana za granicę jako Warenpost International.
string
Zewnętrzny numer śledzenia od dostawcy logistycznego. Może mieć wartość null.
string
Dowolny opis tekstowy zawartości paczki podany podczas tworzenia. Może mieć wartość null.
string
wymagane
Kto wydrukował etykietę: aniva lub external. To wywołanie jest obsługiwane tylko dla przesyłek aniva.
string
Numer referencyjny drugiej paczki w przesyłce dwupaczkowej. null w przypadku paczki w jedną stronę.
object
Adres odbioru. Może mieć wartość null.
object
Adres dostawy. Taka sama struktura jak origin. Może mieć wartość null.
object
Zaplanowane okno odbioru. Może mieć wartość null.
string
Opcjonalne notatki. Może mieć wartość null.
object[]
wymagane
Chronologiczne zdarzenia z cyklu życia przesyłki od dostawcy logistycznego (od najstarszych). Każdy wpis ma pola state, code, detail_code, status, description, location i time. Szczegóły każdego pola znajdziesz w Pobierz przesyłkę. Pusta tablica, jeśli nie odnotowano jeszcze żadnych zdarzeń.
ShipmentAppointmentLink[]
wymagane
Wizyty, które były powiązane z tą przesyłką przed anulowaniem. Każdy wpis ma format { id, added_at }; każde id sprawdź w Pobierz wizytę. Na liście znajdują się tylko wizyty w twoim kontekście dostępu.
ShipmentHomeKitOrderLink[]
wymagane
Zamówienia zestawów domowych powiązane z tą przesyłką, od najstarszego powiązania, w tym samym formacie { id, added_at }. Na liście znajdują się tylko zamówienia w twoim kontekście dostępu. Pusta tablica dla paczek z gabinetów.
string
Czas ostatniego uzgodnienia stanu przesyłki z przewoźnikiem jako znacznik czasu UTC. null do pierwszej synchronizacji.
string
wymagane
Znacznik czasu utworzenia (ISO 8601).
string
Znacznik czasu ostatniej aktualizacji (ISO 8601). Może mieć wartość null.

Odpowiedzi z błędami