Saltar al contenido principal
DELETE
Cancela una orden de envío. Llama a la API del proveedor logístico para cancelar la orden y actualiza el estado del envío a cancelled. Cancelar un envío que ya está en estado cancelled devuelve 200 con ese envío y solo se llama al proveedor una vez. La respuesta incluye Idempotent-Replayed: true para que puedas distinguir una repetición de la llamada que realizó la operación. Consulta Idempotencia.
Los envíos no se pueden cancelar después de la recogida: eso devuelve 409 Conflict.
Una etiqueta de devolución de DHL no puede cancelarse por separado; eso también devuelve 409 Conflict. En su lugar, cancela el paquete de ida. Cancelar un paquete de ida de DHL también cancela sus filas de tramo de devolución en estado pending. Cada una pasa a cancelled con una entrada RETURN_LEG_CANCELLED en status_updates. Consulta Etiquetas de devolución. En una caja con varios kits, cada kit tiene su propia fila de ida y su propia etiqueta de devolución, incluso cuando la caja viaja con la etiqueta de uno solo. Cancelar la fila de ida de un kit también cancela la etiqueta de devolución de ese kit. Para cancelar un paquete de kit a domicilio, todos los pedidos de kit a domicilio vinculados deben estar en tu contexto de acceso. De lo contrario, la llamada devuelve 403. Consulta Acceso.

Solicitud

Parámetros de ruta

string
requerido
ID de referencia del envío (p. ej., P2611194821).

Respuesta

Si la operación tiene éxito, la API devuelve 200 OK con el objeto del envío cancelado.
string
requerido
Identificador de referencia del envío.
string
requerido
Estado del ciclo de vida del envío. Será cancelled tras una cancelación correcta.
string
requerido
Proveedor logístico. Puede ser go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups o dhl_express. Un paquete de kit a domicilio es dhl_parcel, o dhl_warenpost cuando se envía al extranjero como Warenpost International.
string
Número de seguimiento externo del proveedor logístico. Puede ser null.
string
Descripción en texto libre del contenido del paquete, tal como se indicó al crearlo. Puede ser null.
string
requerido
Quién imprimió la etiqueta: aniva o external. Solo los envíos de aniva aceptan esta llamada.
string
Referencia del otro paquete en un envío de dos paquetes. Es null para un paquete solo de ida.
object
Dirección de recogida. Puede ser null.
object
Dirección de entrega. Misma estructura que origin. Puede ser null.
object
Franja de recogida programada. Puede ser null.
string
Notas opcionales. Puede ser null.
object[]
requerido
Eventos cronológicos del ciclo de vida del proveedor logístico (del más antiguo al más reciente). Cada entrada tiene state, code, detail_code, status, description, location y time. Consulta Obtener envío para cada campo. Array vacío si aún no se han registrado eventos.
ShipmentAppointmentLink[]
requerido
Citas que estaban vinculadas a este envío antes de la cancelación. Cada entrada es { id, added_at }; consulta cada id en Obtener cita. Solo se muestran las citas de tu contexto de acceso.
ShipmentHomeKitOrderLink[]
requerido
Pedidos de kits a domicilio vinculados a este envío, del vínculo más antiguo al más reciente, con el mismo formato { id, added_at }. Solo se muestran los pedidos de tu contexto de acceso. Array vacío para paquetes de consultas.
string
Cuándo se sincronizó por última vez el envío con su transportista, como instante UTC. null hasta la primera sincronización.
string
requerido
Marca de tiempo de creación (ISO 8601).
string
Marca de tiempo de la última actualización (ISO 8601). Puede ser null.

Respuestas de error