Saltar al contenido principal
PATCH
Actualiza los detalles del envío, como el horario de recogida, el número de paquetes o las notas. Si cambia algún campo relevante para la logística (fecha de recogida, hora, número de paquetes o peso), la orden logística actual se cancela y se crea una nueva automáticamente. Los campos que omitas se conservan del envío actual. Los campos de horario actualizados se validan según las reglas de horario de recogida.
Los envíos no se pueden modificar después de la recogida. Intentar actualizar un envío que ya ha sido recogido devuelve 409 Conflict.
Un paquete de kit de prueba en casa ya tiene la etiqueta impresa, así que solo puede cambiar notes. Una nueva franja de recogida o un nuevo peso en un paquete de kit de prueba en casa devuelve 409 Conflict; cancélalo y crea un nuevo envío en su lugar. Para actualizar un paquete de kit de prueba en casa, todos los pedidos de kit de prueba en casa vinculados deben estar dentro de 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).

Parámetros del cuerpo

Todos los parámetros del cuerpo son opcionales — incluye solo los campos que quieras cambiar.
string
Nueva fecha de recogida en formato YYYY-MM-DD, interpretada en la zona horaria del lugar de origen.
string
Nueva hora mínima de recogida en formato HH:MM, interpretada como hora local en la zona horaria del lugar de origen.
string
Nueva hora máxima de recogida en formato HH:MM, interpretada como hora local en la zona horaria del lugar de origen.
integer
Nuevo número de paquetes.
number
Nuevo peso en kg.
string
Nuevas notas u observaciones. Máximo 128 caracteres.

Respuesta

En caso de éxito, la API devuelve 200 OK con el envío actualizado.
string
requerido
Identificador de referencia del envío.
string
requerido
Estado del ciclo de vida del envío. Uno de pending, in_transit, delivered, fault o cancelled.
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 vinculadas a este envío, empezando por el vínculo más antiguo. Cada entrada es { id, added_at }; consulta cada id en Obtener cita. Solo se muestran las citas dentro 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