Listar Agendas

Permite obtener el listado de agendas (citas programadas entre vendedores y clientes) registradas en el sistema de forma paginada. Este endpoint soporta filtros por código de agenda, vendedor, cliente, estado y fechas, así como ordenamiento configurable.

Método: GET

Endpoint

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

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

Filtros

Parámetro	Tipo	Descripción
code	Number	Filtra por código exacto de la agenda. Debe ser un número entero.
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.
state	String	Filtra por estado de la agenda. Longitud máxima: 1 carácter. Valores permitidos: A (Asignada), C (Cumplida), I (Cancelada), V (Vencida).
day_from	Date	Retorna agendas cuya fecha de la cita es mayor o igual a este valor. Formato: YYYY-MM-DD.
created_from	Date	Retorna agendas cuya fecha de creación es mayor o igual a este valor. Formato: YYYY-MM-DD.
modified_from	Date	Retorna agendas cuya fecha de modificación es mayor o igual a este valor. Formato: YYYY-MM-DD.

Filtros de fecha

Los filtros day_from, created_from y modified_from se agrupan con un operador OR cuando se usan juntos. Esto significa que al enviar varios de estos filtros, se retornarán agendas que cumplan cualquiera de las condiciones (con fecha de cita desde esa fecha o 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/appointments" \
  -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/appointments?seller_id=V001" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro por estado

curl -X GET "https://api.ventasremotas.com/v1/appointments?state=A&page=1&limit=50" \
  -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/appointments?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 múltiples filtros

curl -X GET "https://api.ventasremotas.com/v1/appointments?seller_id=V001&client_id=CLI-001&day_from=2024-06-01&state=C&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": [
        {
            "code": 1542,
            "seller_id": "V001",
            "client_id": "CLI-001",
            "day": "2025-03-15T10:30:00",
            "state": "C",
            "created_at": "2025-03-10T08:00:00",
            "updated_at": "2025-03-15T11:45:00",
            "executed_at": "2025-03-15T10:35:00",
            "end_date": "2025-03-15T11:30:00",
            "observations": "Visita para presentar nuevo catálogo de productos",
            "internal_code": "AGD-2025-001542",
            "manifest": "MAN-20250315",
            "cancellation_reason": null,
            "cancellation_observations": null,
            "transmitted": "Y",
            "dynamic_client_association": "N",
            "presence_activity": "Y",
            "rescheduled_appointment_code": null
        },
        {
            "code": 1538,
            "seller_id": "V001",
            "client_id": "CLI-045",
            "day": "2025-03-14T14:00:00",
            "state": "I",
            "created_at": "2025-03-10T08:15:00",
            "updated_at": "2025-03-14T18:00:00",
            "executed_at": null,
            "end_date": null,
            "observations": "Seguimiento a pedido pendiente",
            "internal_code": null,
            "manifest": null,
            "cancellation_reason": "CLI_NO_DISPONIBLE",
            "cancellation_observations": "Cliente no se encontraba en el establecimiento",
            "transmitted": "Y",
            "dynamic_client_association": "N",
            "presence_activity": "N",
            "rescheduled_appointment_code": 1560
        }
    ],
    "meta": {
        "totalItems": 95,
        "itemCount": 2,
        "itemsPerPage": 100,
        "totalPages": 1,
        "currentPage": 1
    },
    "links": {
        "self": "https://api.ventasremotas.com/v1/appointments?page=1&limit=100",
        "first": "https://api.ventasremotas.com/v1/appointments?page=1&limit=100",
        "prev": null,
        "next": null,
        "last": "https://api.ventasremotas.com/v1/appointments?page=1&limit=100"
    }
}

Descripción de campos de respuesta

Objeto data[] (Agenda)

Cada elemento del array data contiene los siguientes campos:

Campo	Tipo	Descripción
code	Number	Código único de la agenda
seller_id	String	Código del vendedor asignado a la agenda
client_id	String	Código del cliente asociado a la agenda
day	DateTime	Fecha y hora programada de la agenda. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)
state	String	Estado de la agenda: A (Asignada), C (Cumplida), I (Cancelada), V (Vencida) (puede ser null)
created_at	DateTime	Fecha y hora de creación del registro. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)
updated_at	DateTime	Fecha y hora de última modificación. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)
executed_at	DateTime	Fecha y hora en que se ejecutó la agenda. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)
end_date	DateTime	Fecha y hora de finalización de la agenda. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)
observations	String	Observaciones o notas adicionales sobre la agenda (puede ser null)
internal_code	String	Código interno de referencia (puede ser null)
manifest	String	Código del manifiesto asociado (puede ser null)
cancellation_reason	String	Causal de cancelación o incumplimiento de la agenda (puede ser null)
cancellation_observations	String	Observaciones detalladas sobre la cancelación o incumplimiento (puede ser null)
transmitted	String	Estado de descarga hacia la interfaz (puede ser null)
dynamic_client_association	String	Indica si la agenda fue creada por asociación dinámica de cliente/cliente no asignado; valores posibles: Y, N o null
presence_activity	String	Indica si la agenda requiere presencialidad aunque el usuario móvil no tenga restricción de proximidad, o si se permite que sea no presencial aunque el usuario sí tenga restricción de proximidad. Valores posibles: Y, N, '' o null.
rescheduled_appointment_code	Number	Aplica en agendas canceladas, asocia el código de la nueva agenda que nace al realizar una reprogramación (puede ser null).

Objeto meta (Metadatos de paginación)

Campo	Tipo	Descripción
totalItems	Number	Cantidad total de agendas que coinciden con los filtros
itemCount	Number	Cantidad de agendas 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": "seller_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": "seller_id",
            "message": "Value exceeds maximum length of 18"
        }
    ]
}

Valor no permitido para estado

{
    "statusCode": 400,
    "errors": [
        {
            "param": "state",
            "message": "Value 'X' is not allowed. Allowed values: C, I, A, V"
        }
    ]
}

Código de agenda no es un entero válido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "code",
            "message": "Value 'abc' is not a valid integer"
        }
    ]
}

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	seller_id, client_id, state, code
Value 'X' is not a valid date (expected format: YYYY-MM-DD)	day_from, created_from, modified_from
Value exceeds maximum length of 18	seller_id, client_id
Value exceeds maximum length of 1	state
Value 'X' is not allowed. Allowed values: C, I, A, V	state
Value 'X' is not a valid integer	code

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.