Listar Visitas No Efectivas

Permite obtener el listado de visitas no efectivas registradas en el sistema de forma paginada. Una visita no efectiva es una visita de campo realizada por un vendedor a un cliente donde no se concretó una venta, identificada por tener un código de justificación de no-venta y haber sido originada desde un dispositivo móvil. Este endpoint soporta filtro por fecha de creación y ordenamiento configurable.

Método: GET

Endpoint

https://api.ventasremotas.com/v1/ineffective-visits

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 visitas no efectivas con la paginación por defecto.

Filtros

Parámetro	Tipo	Descripción
code	String	Filtra por código exacto de la visita no efectiva.
seller_id	String	Filtra por código exacto de vendedor. Longitud máxima: 18 caracteres.
client_id	String	Filtra por código exacto de cliente. Longitud máxima: 18 caracteres.
created_from	Date	Retorna visitas cuya fecha de creación es mayor o igual a este valor. Formato: YYYY-MM-DD.

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/ineffective-visits" \
  -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/ineffective-visits?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/ineffective-visits?client_id=CLI-042" \
  -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/ineffective-visits?created_from=2025-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 múltiples filtros

curl -X GET "https://api.ventasremotas.com/v1/ineffective-visits?seller_id=VEN-001&client_id=CLI-042&created_from=2025-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": [
        {
            "seller_id": "VEN-001",
            "client_id": "CLI-042",
            "code": "NEV-2025-000123",
            "transmitted": "N",
            "created_at": "2025-06-01T10:30:00",
            "address": "Cra 15 #80-25, Bogotá",
            "latitude": 4.6709886,
            "longitude": -74.052092,
            "visit_time": 480,
            "causal": "PROD-NO-DISP",
            "observations": "El cliente indicó que no necesita el producto en este momento."
        },
        {
            "seller_id": "VEN-002",
            "client_id": "CLI-087",
            "code": "NEV-2025-000124",
            "transmitted": null,
            "created_at": "2025-06-01T11:15:00",
            "address": null,
            "latitude": null,
            "longitude": null,
            "visit_time": null,
            "causal": "PRECIO",
            "observations": null
        }
    ],
    "meta": {
        "totalItems": 1842,
        "itemCount": 2,
        "itemsPerPage": 100,
        "totalPages": 19,
        "currentPage": 1
    },
    "links": {
        "self": "https://api.ventasremotas.com/v1/ineffective-visits?page=1&limit=100",
        "first": "https://api.ventasremotas.com/v1/ineffective-visits?page=1&limit=100",
        "prev": null,
        "next": "https://api.ventasremotas.com/v1/ineffective-visits?page=2&limit=100",
        "last": "https://api.ventasremotas.com/v1/ineffective-visits?page=19&limit=100"
    }
}

Descripción de campos de respuesta

Objeto data[] (Visita No Efectiva)

Cada elemento del array data contiene los siguientes campos:

Campo	Tipo	Descripción
seller_id	String	Código del vendedor de campo que realizó la visita
client_id	String	Código del cliente visitado
code	String	Identificador único del registro de visita no efectiva
transmitted	String	Indica si el registro fue transmitido al ERP: 'S' (sí) o 'N' (no). Puede ser null si no aplica.
created_at	DateTime	Fecha y hora de registro de la visita. Formato: yyyy-MM-ddTHH:mm:ss
address	String	Dirección capturada en el dispositivo móvil durante la visita (puede ser null)
latitude	Number	Coordenada GPS de latitud de la visita. Puede ser null o 0; en ese caso no se pudo obtener la coordenada desde el móvil.
longitude	Number	Coordenada GPS de longitud de la visita. Puede ser null o 0; en ese caso no se pudo obtener la coordenada desde el móvil.
visit_time	Number	Duración de la visita en segundos (puede ser null)
causal	String	Código de justificación de no-venta registrado en el sistema. Puede ser null.
observations	String	Observaciones o notas adicionales capturadas durante la visita. Puede ser null.

Objeto meta (Metadatos de paginación)

Campo	Tipo	Descripción
totalItems	Number	Cantidad total de visitas no efectivas que coinciden con los filtros
itemCount	Number	Cantidad de visitas 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": "created_from",
            "message": "Value must not be empty"
        }
    ]
}

Fecha con formato inválido

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

Valor excede longitud máxima

{
    "statusCode": 400,
    "errors": [
        {
            "param": "seller_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	code, seller_id, client_id, created_from
Value 'X' is not a valid date (expected format: YYYY-MM-DD)	created_from
Value exceeds maximum length of 18	seller_id, client_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.