Saltar al contingut principal
DELETE
Cancel·la una comanda d’enviament. Això crida l’API del proveïdor logístic per cancel·lar la comanda i actualitza l’estat de l’enviament a cancelled. Cancel·lar un enviament que ja està en estat cancelled retorna 200 amb aquest enviament, i el proveïdor només es crida una vegada. La resposta inclou Idempotent-Replayed: true perquè puguis distingir una repetició de la crida que ha fet la feina. Consulta Idempotència.
Els enviaments no es poden cancel·lar després de la recollida — això retorna 409 Conflict.
Una etiqueta de retorn de DHL no es pot cancel·lar per si sola; això també retorna 409 Conflict. En lloc d’això, cancel·la el paquet d’anada. Cancel·lar un paquet d’anada de DHL també cancel·la les seves files de trajecte de retorn en estat pending. Cadascuna passa a cancelled amb una entrada RETURN_LEG_CANCELLED a status_updates. Consulta Etiquetes de retorn. En una caixa amb diversos kits, cada kit té la seva pròpia fila d’anada i la seva pròpia etiqueta de retorn, fins i tot quan la caixa viatja amb l’etiqueta d’un sol kit. Cancel·lar la fila d’anada d’un kit també cancel·la l’etiqueta de retorn d’aquest kit. Per cancel·lar un paquet de kit a domicili, totes les comandes de kit a domicili vinculades han d’estar dins del teu context d’accés. En cas contrari, la crida retorna 403. Consulta Accés.

Sol·licitud

Paràmetres de ruta

string
requerit
ID de referència de l’enviament (p. ex., P2611194821).

Resposta

Si té èxit, l’API retorna 200 OK amb l’objecte d’enviament cancel·lat.
string
requerit
Identificador de referència de l’enviament.
string
requerit
Estat del cicle de vida de l’enviament. Serà cancelled després d’una cancel·lació correcta.
string
requerit
Proveïdor logístic. Pot ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquet de kit a domicili és dhl_parcel, o dhl_warenpost quan s’envia a l’estranger com a Warenpost International.
string
Número de seguiment extern del proveïdor logístic. Pot ser null.
string
Descripció en text lliure del contingut del paquet, tal com es va indicar en crear-lo. Pot ser null.
string
requerit
Qui ha imprès l’etiqueta: aniva o external. Només els enviaments d’aniva accepten aquesta crida.
string
Referència de l’altre paquet d’un enviament de dos paquets. null per a un paquet d’un sol trajecte.
object
Adreça de recollida. Pot ser null.
object
Adreça de lliurament. Mateixa estructura que origin. Pot ser null.
object
Franja de recollida programada. Pot ser null.
string
Notes opcionals. Pot ser null.
object[]
requerit
Esdeveniments cronològics del cicle de vida del proveïdor logístic (el més antic primer). Cada entrada té state, code, detail_code, status, description, location i time. Consulta Obtén l’enviament per a cada camp. Matriu buida si encara no s’ha observat cap esdeveniment.
ShipmentAppointmentLink[]
requerit
Cites que estaven vinculades a aquest enviament abans de la cancel·lació. Cada entrada és { id, added_at }; consulta cada id a Obtén la cita. Només es llisten les cites del teu context d’accés.
ShipmentHomeKitOrderLink[]
requerit
Comandes de kits a domicili vinculades a aquest enviament, el vincle més antic primer, amb el mateix format { id, added_at }. Només es llisten les comandes del teu context d’accés. Matriu buida per als paquets de consulta.
string
Quan es va conciliar l’enviament per última vegada amb el transportista, com a instant UTC. null fins a la primera sincronització.
string
requerit
Marca de temps de creació (ISO 8601).
string
Marca de temps de l’última actualització (ISO 8601). Pot ser null.

Respostes d’error