En Optiroute las rutas corresponden al circuito optimizable de reparto de servicio realizado particularmente por un vehículo y conductor. Todas las rutas están contenidas en algún plan de rutas.
Como las rutas están contenidas en planes de rutas, para crearlas y eliminarlas se debe utilizar endpoints de la API de Planes de Rutas.
Obtener ruta particular
Para obtener el detalle de una ruta desde Optiroute debes realizar una llamada tipo GET en el endpoint de la API de rutas agregando el id de la ruta al final de la URL, de la siguiente manera:
https://testing.optiroute.cl/api/v1/web-routes/{id}/
Si la llamada fue realizada correctamente la API deberá retornar un objeto de tipo ruta de respuesta.
Actualizar configuración de la ruta
Es posible actualizar la información de una ruta particular de un plan de rutas. Algunos de los parámetros modificados serán aplicados automáticamente en la ruta y otros serán aplicados luego de optimizar el plan de rutas o la ruta particular.
Para actualizar la ruta en Optiroute debes realizar una llamada tipo PUT o PATCH en el endpoint de la API de ruta agregando el ID de la ruta al final de la URL, como por ejemplo:
https://testing.optiroute.cl/api/v1/web-routes/{id}/
Un ejemplo del contenido de la llamada es el siguiente:
{
'driver': {'id': 12334},
'start_Warehouse': {'id': 45432},
'break_start': '11:00',
'break_end': '12:00',
'speed_factor': 1.05,
'use_always': true,
}
En caso de cualquier error de validación la API entregará la descripción apropiada.
Agregar pedidos a una ruta
Cuando se desea agregar pedidos a una ruta de un plan de rutas (porque ya fue optimizado) se debe ingresar como atributo un objeto de tipo lista de pedidos de carga masiva en el siguiente endpoint, agregando el ID de la ruta a la URL, como por ejemplo:
https://testing.optiroute.cl/api/v1/web-routes/{id}/add_service_requests/Un ejemplo del contenido de la llamada es el siguiente:
{
'service_requests': [12345678, 12345679, 923485843],
}
Optimizar una ruta
El proceso de optimización de una ruta corresponde al reorden de los pedidos que ya fueron asignados a la ruta, de manera de satisfacer la configuración de optimización agregada al plan de rutas.
Es posible que algunos pedidos no sean asignados a la ruta, por lo que serán agregados a la ruta de descartados o (dropped_route en los atributos de la ruta).
Puedes realizar el número de optimizaciones que quieras. Si encuentras que la optimización encontrada no satisface tus requerimientos puedes actualizar la configuración del plan de rutas y optimizar nuevamente la ruta en particular.
Para optimizar una ruta se debe agregar su ID a la URL, como por ejemplo:
https://testing.optiroute.cl/api/v1/web-routes/{id}/optimize/
Cancelar una optimización en curso
Para cancelar un proceso de optimización de una ruta que se encuentra en curso se debe realizar una llamada de tipo POST, agregando su ID a la URL, en el siguiente endpoint:
https://testing.optiroute.cl/api/v1/web-routes/{id}/stop_optimization/
Notificar al conductor
Optiroute Driver es la aplicación móvil con la cual los conductores pueden recorrer y completar los puntos de la ruta que tienen asignada.
Para notificar al conductor en Optiroute Driver respecto a la ruta asignada se debe realizar una llamada de tipo POST, agregando el ID de la ruta a la URL, en el siguiente endpoint:
https://app.optiroute.cl/api/v1/web-routes/{id}/notify_driver/
Desnotificar al conductor
Para desnotificar al conductor en Optiroute Driver se debe realizar una llamada de tipo POST, agregando el ID de la ruta a la URL, en el siguiente endpoint:
https://app.optiroute.cl/api/v1/web-routes/{id}/denotify_driver/
Con esta acción el conductor dejará de ver la ruta previamente notificada en la aplicación móvil Optiroute Driver.
Activar la notificaciones a los clientes
Optiroute permite notificar a los clientes respecto al horario de llegada de su servicio a través de correo electrónico. Si el pedido está asociado a un cliente con correo correctamente configurado se le informará el rango de horario de llegada.
Es posible configurar los distintos eventos bajo los cuales se notificará el rango de llegada al cliente en tu cuenta Optiroute en la pestaña Correos dentro de la sección Configuración en el menú de Notificaciones a clientes.
Para activar la notificación de los clientes respecto al rango de horario de llegada de su servicio se debe realizar una llamada de tipo POST, agregando el ID de la ruta a la URL, en el siguiente endpoint:
https://app.optiroute.cl/api/v1/web-routes/{id}/notify_customers/
Desactivar las notificaciones a los clientes
Para desactivar las notificaciones por correo a todos los clientes de todas las rutas se debe realizar una llamada de tipo POST, agregando el ID de la ruta a la URL, en el siguiente endpoint:
https://app.optiroute.cl/api/v1/web-routes/{id}/denotify_customers/