Listar Rutas

Permite obtener el listado de rutas registradas en el sistema de forma paginada. Este endpoint soporta filtros por código de cliente, código de vendedor, fecha de creación y fecha de modificación, así como ordenamiento configurable.

Método: GET

Endpoint

https://api.ventasremotas.com/v1/routes

Nota

Es necesario el envío del token de acceso Subscription-Key para hacer uso de este endpoint. Para ver cómo generar el token, vea Activación Suscripción a RSales API.

Encabezados de la solicitud

Header	Valor	Descripción	Requerido
Accept	application/json	Indica que la respuesta debe estar en formato JSON	No
Subscription-Key	{subscription_key}	Clave de suscripción para acceder a la API	Sí
Authorization	Bearer {access_token}	Token de acceso obtenido del endpoint /token	Sí

---

Parámetros de Consulta (Query Parameters)

Todos los parámetros son opcionales. Si no se especifican, se retornan todas las rutas con la paginación por defecto.

Filtros

Parámetro	Tipo	Descripción
client_id	String	Filtra por código exacto de cliente. Longitud máxima: 18 caracteres.
seller_id	String	Filtra por código exacto de vendedor/usuario. Longitud máxima: 18 caracteres.
created_from	Date	Retorna rutas cuya fecha de creación es mayor o igual a este valor. Formato: YYYY-MM-DD.
modified_from	Date	Retorna rutas cuya fecha de modificación es mayor o igual a este valor. Formato: YYYY-MM-DD.

Filtros de fecha

Los filtros created_from y modified_from se agrupan con un operador OR cuando se usan juntos. Esto significa que al enviar ambos, se retornarán rutas que cumplan cualquiera de las dos condiciones (creadas desde esa fecha o modificadas desde esa fecha).

Ordenamiento

Parámetro	Tipo	Descripción
sort	String	Campo y dirección de ordenamiento. Por defecto: fecha de creación descendente.

Campos de ordenamiento disponibles

Valor	Descripción
created_at	Ordena por fecha de creación ascendente (ASC)
-created_at	Ordena por fecha de creación descendente (DESC)

Ordenamiento por defecto

Si no se especifica el parámetro sort, los resultados se ordenan por fecha de creación descendente (más recientes primero).

Paginación

Parámetro	Tipo	Por defecto	Restricciones	Descripción
page	Number	1	Mínimo: 1	Número de página (1-indexed)
limit	Number	100	Mínimo: 1, Máximo: 1000	Cantidad de resultados por página

---

Ejemplo de Solicitud

Petición básica (sin filtros)

curl -X GET "https://api.ventasremotas.com/v1/routes" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro por vendedor

curl -X GET "https://api.ventasremotas.com/v1/routes?seller_id=VEN-001" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro por cliente

curl -X GET "https://api.ventasremotas.com/v1/routes?client_id=CLI-001" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro de fecha y paginación

curl -X GET "https://api.ventasremotas.com/v1/routes?created_from=2024-01-01&page=1&limit=50" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con ordenamiento ascendente

curl -X GET "https://api.ventasremotas.com/v1/routes?sort=created_at&page=2&limit=100" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con múltiples filtros de fecha

curl -X GET "https://api.ventasremotas.com/v1/routes?created_from=2024-01-01&modified_from=2024-06-01&sort=-created_at&limit=200" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

---

Ejemplo de Respuesta

200 - OK

{
    "data": [
        {
            "client_id": "CLI-001",
            "seller_id": "VEN-001",
            "day": 1,
            "state": "Y",
            "frequency": 1,
            "sequence": 1,
            "associate_sales_portal": "Y",
            "transmitted": "N",
            "created_at": "2024-06-15T10:30:00",
            "updated_at": "2024-09-20T14:15:00"
        }
    ],
    "meta": {
        "totalItems": 1250,
        "itemCount": 100,
        "itemsPerPage": 100,
        "totalPages": 13,
        "currentPage": 1
    },
    "links": {
        "self": "https://api.ventasremotas.com/v1/routes?page=1&limit=100",
        "first": "https://api.ventasremotas.com/v1/routes?page=1&limit=100",
        "prev": null,
        "next": "https://api.ventasremotas.com/v1/routes?page=2&limit=100",
        "last": "https://api.ventasremotas.com/v1/routes?page=13&limit=100"
    }
}

Descripción de campos de respuesta

Objeto data[] (Ruta)

Cada elemento del array data contiene los siguientes campos:

Campo	Tipo	Descripción
client_id	String	Código del cliente asignado desde el ERP
seller_id	String	Código del vendedor/usuario asignado desde el ERP
day	Number	Día de la semana en que se realiza la visita: 0 Domingo, 1 Lunes, 2 Martes, 3 Miércoles, 4 Jueves, 5 Viernes, 6 Sábado, 7 No asignado
state	String	Disponibilidad de la ruta: Y (activa) o N (inactiva)
frequency	Number	Semanas del mes en que se repite la visita (0-15). 0 = no aplica, 1 = todas las semanas, 15 = solo semana 1
sequence	Number	Secuencia en que se visita al cliente. El móvil usa este campo para ordenar los clientes (puede ser null)
associate_sales_portal	String	Indica si al usuario móvil se le asocia la venta del cliente realizada desde el portal de clientes: Y o N (puede ser null)
transmitted	String	Indica si la ruta fue transmitida (puede ser null)
created_at	DateTime	Fecha de creación de la ruta. Formato: yyyy-MM-ddTHH:mm:ss
updated_at	DateTime	Fecha de actualización de la ruta. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)

Objeto meta (Metadatos de paginación)

Campo	Tipo	Descripción
totalItems	Number	Cantidad total de rutas que coinciden con los filtros
itemCount	Number	Cantidad de rutas en la página actual
itemsPerPage	Number	Cantidad de items por página solicitados
totalPages	Number	Total de páginas disponibles
currentPage	Number	Número de la página actual

Objeto links (Enlaces de navegación)

Campo	Tipo	Descripción
self	String	URL de la página actual
first	String	URL de la primera página
prev	String	URL de la página anterior (null si es la primera página)
next	String	URL de la página siguiente (null si es la última página)
last	String	URL de la última página

Status 400

Los errores de validación de parámetros de consulta retornan un array de errores, donde cada error indica el parámetro problemático:

Filtro no válido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "invalid_param",
            "message": "The field is not a valid filter parameter"
        }
    ]
}

Valor de filtro vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "client_id",
            "message": "Value must not be empty"
        }
    ]
}

Fecha con formato inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "created_from",
            "message": "Value '15-01-2024' is not a valid date (expected format: YYYY-MM-DD)"
        }
    ]
}

Valor excede longitud máxima

{
    "statusCode": 400,
    "errors": [
        {
            "param": "client_id",
            "message": "Value exceeds maximum length of 18"
        }
    ]
}

Campo de ordenamiento inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "sort",
            "message": "The field 'invalid_field' is not a valid sort field."
        }
    ]
}

Parámetro sort vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "sort",
            "message": "The parameter must not be empty"
        }
    ]
}

Parámetro de paginación inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "page",
            "message": "The parameter must be a valid integer"
        }
    ]
}

Página menor al mínimo

{
    "statusCode": 400,
    "errors": [
        {
            "param": "page",
            "message": "The parameter must be greater than or equal to 1"
        }
    ]
}

Límite excede el máximo

{
    "statusCode": 400,
    "errors": [
        {
            "param": "limit",
            "message": "The parameter must be less than or equal to 1000"
        }
    ]
}

Límite vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "limit",
            "message": "The parameter must not be empty"
        }
    ]
}

Errores múltiples

El endpoint puede retornar múltiples errores de validación en una sola respuesta. Por ejemplo, si se envía un filtro inválido y un parámetro de paginación incorrecto al mismo tiempo, ambos errores aparecerán en el array de errors.

Tabla resumen de errores de validación

Errores de filtros:

Error	Aplica a
The field is not a valid filter parameter	Cualquier parámetro no reconocido
Value must not be empty	client_id, seller_id
Value 'X' is not a valid date (expected format: YYYY-MM-DD)	created_from, modified_from
Value exceeds maximum length of 18	client_id, seller_id

Errores de ordenamiento:

Error	Aplica a
The parameter must not be empty	sort
The field 'X' is not a valid sort field.	sort

Errores de paginación:

Error	Aplica a
The parameter must not be empty	page, limit
The parameter must be a valid integer	page, limit
The parameter must be greater than or equal to 1	page, limit
The parameter must be less than or equal to 1000	limit

Status 500

Error de conexión a base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Error connecting to database"
        }
    ]
}

Error de operación en base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Database operation failed"
        }
    ]
}

Error en validaciones

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error in the validations"
        }
    ]
}

Error inesperado

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error"
        }
    ]
}

Error del Servidor

Estos errores indican problemas internos en el servidor o la base de datos. Si persisten, contacta al equipo de soporte.