Salt la conținutul principal
DELETE
Anulează o comandă de expediere. Acest apel contactează API-ul furnizorului de logistică pentru a anula comanda și actualizează statusul expedierii la cancelled. Anularea unei expedieri care are deja statusul cancelled returnează 200 cu acea expediere, iar furnizorul este apelat o singură dată. Răspunsul include Idempotent-Replayed: true, astfel încât să poți distinge o repetare de apelul care a efectuat acțiunea. Vezi Idempotență.
Expedierile nu pot fi anulate după ridicare — în acest caz se returnează 409 Conflict.
O etichetă de retur DHL nu poate fi anulată separat; și acest lucru returnează 409 Conflict. Anulează coletul de dus în schimb. Anularea unui colet DHL de dus anulează și înregistrările sale de retur aflate în starea pending. Fiecare devine cancelled cu o intrare RETURN_LEG_CANCELLED în status_updates. Vezi Etichete de retur. Într-o cutie cu mai multe kituri, fiecare kit are propria înregistrare de dus și propria etichetă de retur, chiar dacă cutia circulă cu eticheta unui singur kit. Anularea înregistrării de dus a unui kit anulează și eticheta de retur a acelui kit. Pentru a anula un colet cu kit pentru acasă, fiecare comandă asociată de kit pentru acasă trebuie să fie în contextul tău de acces. În caz contrar, apelul returnează 403. Vezi Acces.

Cerere

Parametri de cale

string
obligatoriu
ID-ul de referință al expedierii (de ex., P2611194821).

Răspuns

În caz de succes, API-ul returnează 200 OK cu obiectul expedierii anulate.
string
obligatoriu
Identificatorul de referință al expedierii.
string
obligatoriu
Statusul ciclului de viață al expedierii. Va fi cancelled după o anulare reușită.
string
obligatoriu
Furnizorul de logistică. Una dintre valorile go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups sau dhl_express. Un colet cu kit pentru acasă folosește dhl_parcel sau dhl_warenpost când pleacă în străinătate ca Warenpost International.
string
Numărul extern de urmărire de la furnizorul de logistică. Poate fi null.
string
Descriere în text liber a conținutului coletului, așa cum a fost furnizată la creare. Poate fi null.
string
obligatoriu
Cine a tipărit eticheta: aniva sau external. Doar expedierile aniva acceptă acest apel.
string
Referința celuilalt colet dintr-o expediere cu două colete. null pentru un colet într-un singur sens.
object
Adresa de ridicare. Poate fi null.
object
Adresa de livrare. Aceeași structură ca origin. Poate fi null.
object
Intervalul programat de ridicare. Poate fi null.
string
Note opționale. Poate fi null.
object[]
obligatoriu
Evenimente cronologice din ciclul de viață de la furnizorul de logistică (cele mai vechi primele). Fiecare intrare conține state, code, detail_code, status, description, location și time. Vezi Obține expedierea pentru fiecare câmp. Listă goală dacă nu s-au înregistrat încă evenimente.
ShipmentAppointmentLink[]
obligatoriu
Programările care au fost asociate cu această expediere înainte de anulare. Fiecare intrare are forma { id, added_at }; verifică fiecare id prin Obține programarea. Sunt listate doar programările din contextul tău de acces.
ShipmentHomeKitOrderLink[]
obligatoriu
Comenzile de kituri pentru acasă asociate cu această expediere, de la cea mai veche asociere, în aceeași formă { id, added_at }. Sunt listate doar comenzile din contextul tău de acces. Listă goală pentru coletele de la cabinete.
string
Momentul ultimei sincronizări a expedierii cu transportatorul, ca moment UTC. null până la prima sincronizare.
string
obligatoriu
Data și ora creării (ISO 8601).
string
Data și ora ultimei actualizări (ISO 8601). Poate fi null.

Răspunsuri de eroare