Crear Agendas

Permite crear una o múltiples agendas (citas programadas entre un vendedor y un cliente) en el sistema mediante una única petición. Este endpoint está diseñado para operaciones en lote (batch), permitiendo insertar hasta 10,000 registros por petición.

Método: POST

Endpoint

https://api.ventasremotas.com/v1/appointments/batch-create

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
Content-Type	application/json	Indica que los datos se envían en formato JSON
Accept	application/json	Indica que la respuesta debe estar en formato JSON
Subscription-Key	{subscription_key}	Clave de suscripción para acceder a la API
Authorization	Bearer {access_token}	Token de acceso obtenido del endpoint /token

---

Parámetros del Cuerpo (Body)

El body debe ser un array de objetos, donde cada objeto representa una agenda a crear.

Límites

Parámetro	Valor	Descripción
Mínimo de items	1	El array no puede estar vacío
Máximo de items	10,000	Número máximo de agendas por petición

Campos

El cuerpo (Body) de la solicitud debe enviarse en formato JSON y debe incluir un array con los siguientes parámetros.

Importante

Todos los campos requeridos deben estar presentes en cada objeto del array, incluso los campos que admiten nulo (Nulo: Sí). Si un campo no aplica para una agenda, envíelo con valor null.

Campo	Tipo	Nulo	Restricciones	Descripción
seller_id	string (max 18)	No	No permite: espacio, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Código del vendedor asignado a la agenda
client_id	string (max 18)	No	No permite: espacio, #, %, &, *, {`, `}, \, :, <, >, ?, /, +, .	Código del cliente asociado a la agenda
day	datetime	No	Formato: YYYY-MM-DD HH:MM:SS	Fecha y hora programada de la agenda
until_date	datetime	No	Formato: YYYY-MM-DD HH:MM:SS	Fecha y hora de finalización de la agenda
observations	string (max 500)	Sí		Observaciones o notas adicionales sobre la agenda
internal_code	string (max 50)	Sí		Código interno de referencia
manifest	string (max 20)	Sí		Código del manifiesto asociado
allow_presential_activity	string (max 1)	Sí	Valores permitidos: Y, N	Indica si la agenda requiere presencialidad

Formato de tipos de dato

• string (max N): Cadena de texto con longitud máxima de N caracteres.
• datetime: Fecha y hora en formato YYYY-MM-DD HH:MM:SS. Ejemplo: 2026-07-15 10:00:00.

---

Ejemplo de Solicitud

Aquí tienes un ejemplo de cómo debería quedar el cuerpo de la solicitud en formato JSON:

[
  {
    "seller_id": "V001",
    "client_id": "CLI-001",
    "day": "2026-07-15 10:00:00",
    "until_date": "2026-07-15 10:15:00",
    "observations": "Visita para presentar nuevo catálogo de productos",
    "internal_code": "AGD-2026-001542",
    "manifest": "MAN-20260715",
    "allow_presential_activity": "Y"
  },
  {
    "seller_id": "V002",
    "client_id": "CLI-045",
    "day": "2026-07-16 14:00:00",
    "until_date": "2026-07-16 14:15:00",
    "observations": null,
    "internal_code": null,
    "manifest": null,
    "allow_presential_activity": null
  }
]

---

Ejemplo de Respuesta

201 - OK

{
    "statusCode": 201,
    "message": "Appointments created successfully"
}

Comportamiento de inserción

• Una agenda solo se inserta si el vendedor (seller_id) y el cliente (client_id) existen, están activos, y existe una ruta activa entre ambos. Si alguna de estas condiciones no se cumple, el registro se omite sin generar error.
• Si se envía internal_code, este actúa como clave de deduplicación junto con seller_id y client_id. Si ya existe una agenda con esa combinación, no se inserta un duplicado.
• Si internal_code es null, la deduplicación se realiza por seller_id + client_id + day. Si ya existe una agenda con esa combinación, no se inserta un duplicado.
• Las agendas creadas quedan en estado A (Asignada).

Status 400

{
    "statusCode": 400,
    "errors": [
        {
            "message": "Invalid JSON in request body"
        }
    ]
}

Status 415

{
    "statusCode": 415,
    "errors": [
        {
            "message": "Content-Type: application/json is required"
        }
    ]
}

Status 422

Errores globales (estructura del body)

Si el body no es un array:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Request body must be an array"
        }
    ]
}

Si el array está vacío:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Request body cannot be empty"
        }
    ]
}

Si excede el límite de 10,000 items:

{
    "statusCode": 422,
    "errors": [
        {
            "message": "Array exceeds maximum limit of 10000 items"
        }
    ]
}

Errores por item (validación de campos)

Los errores se agrupan por el índice del item en el array:

{
    "statusCode": 422,
    "errors": [
        {
            "index": 0,
            "errors": [
                {
                    "field": "day",
                    "message": "Field is required"
                },
                {
                    "field": "seller_id",
                    "message": "Field cannot be null or empty"
                }
            ]
        },
        {
            "index": 2,
            "errors": [
                {
                    "field": "client_id",
                    "message": "Field exceeds maximum length of 18 characters"
                }
            ]
        }
    ]
}

Tipos de Errores de Validación por Campo

Errores de presencia y nulidad:

Error	Descripción
Field is required	El campo no fue enviado en el objeto (la clave no existe)
Field cannot be null or empty	El campo fue enviado con valor null o vacío y no acepta nulos
Unknown field	Se envió un campo que no existe en la configuración
Item must be an object	Un elemento del array no es un objeto JSON

Errores de tipo de dato:

Error	Descripción
Field must be a string	El valor no es una cadena de texto
Field 'X' must be a valid datetime (YYYY-MM-DD HH:MM:SS)	El valor no es una fecha y hora válida (campos day, until_date)

Errores de longitud:

Error	Descripción
Field exceeds maximum length of X characters	La cadena excede la longitud máxima permitida

Errores de valores permitidos:

Error	Descripción
Value must be one of: Y, N	El valor no está en la lista de valores permitidos (campo allow_presential_activity)

Errores de formato:

Error	Descripción
Field contains forbidden characters. The following are not allowed: space, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Los campos seller_id o client_id contienen caracteres prohibidos

Status 423

{
    "statusCode": 423,
    "errors": [
        {
            "message": "Resource is locked and cannot be accessed."
        }
    ]
}

Recurso bloqueado

Este error ocurre cuando otra operación de creación de agendas con la misma Subscription-Key está en progreso. Espere a que la operación anterior finalice e intente nuevamente.

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 Redis

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Redis 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, la base de datos o el servicio de cache. Si persisten, contacta al equipo de soporte.