Crear Rutas

Permite crear una o múltiples rutas 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/routes/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 ruta 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 rutas 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 ruta, envíelo con valor null.

Campo	Tipo	Nulo	Restricciones	Descripción
client_id	string (max 18)	No	No permite: espacio, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Código del cliente asignado desde el ERP
seller_id	string (max 18)	No	No permite: espacio, #, %, &, *, {`, `}, \, :, <, >, ?, /, +, .	Código del vendedor/usuario asignado desde el ERP
day	int	No	Mínimo: 0, Máximo: 7	Día de la semana en que se realiza la visita. Ver valores de día
state	string (max 1)	No	Valores permitidos: Y, N	Determina la disponibilidad de la ruta: Y activa, N inactiva
frequency	int	No	Mínimo: 0, Máximo: 15	Semanas del mes en que se repite la visita. Ver valores de frecuencia
sequence	int	Sí		Secuencia en que se visita al cliente. El móvil usa este campo para ordenar los clientes en la ruta
associate_sales_portal	string (max 1)	Sí	Valores permitidos: Y, N	Indica si al usuario móvil se le asocia la venta del cliente realizada desde el portal de clientes: Y sí, N no

Formato de tipos de dato

• string (max N): Cadena de texto con longitud máxima de N caracteres.
• int: Número entero.

Valores de día

Valor	Día
0	Domingo
1	Lunes
2	Martes
3	Miércoles
4	Jueves
5	Viernes
6	Sábado
7	No asignado

Valores de frecuencia

Indica las semanas del mes en que se repite la visita:

Valor	Semanas de visita
0	No aplica
1	Semana 1, 2, 3 y 4
2	Semana 1, 2 y 3
3	Semana 2, 3 y 4
4	Semana 1, 3 y 4
5	Semana 1, 2 y 4
6	Semana 1 y 2
7	Semana 1 y 3
8	Semana 1 y 4
9	Semana 2 y 3
10	Semana 2 y 4
11	Semana 3 y 4
12	Semana 4
13	Semana 3
14	Semana 2
15	Semana 1

Nota sobre semanas

Para meses con 5 semanas, la semana 5 se toma como semana 4.

---

Ejemplo de Solicitud

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

[
  {
    "client_id": "CLI-001",
    "seller_id": "VEN-001",
    "day": 1,
    "state": "Y",
    "frequency": 1,
    "sequence": 1,
    "associate_sales_portal": "Y"
  },
  {
    "client_id": "CLI-002",
    "seller_id": "VEN-001",
    "day": 3,
    "state": "Y",
    "frequency": 2,
    "sequence": null,
    "associate_sales_portal": null
  }
]

---

Ejemplo de Respuesta

201 - OK

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

Importante

Las rutas que ya existan en el sistema (misma combinación de client_id, seller_id y day) serán ignoradas sin generar error. Solo se insertarán las rutas nuevas.

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": "client_id",
                    "message": "Field is required"
                },
                {
                    "field": "day",
                    "message": "Field must be of type int"
                }
            ]
        },
        {
            "index": 2,
            "errors": [
                {
                    "field": "seller_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 must be of type int	El valor no es un número entero válido

Errores de longitud:

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

Errores de rango:

Error	Descripción
Field must be greater than or equal to X	El valor entero es menor al mínimo permitido
Field must be less than or equal to X	El valor entero es mayor al máximo permitido

Errores de valores permitidos:

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

Errores de formato:

Error	Descripción
Field contains forbidden characters. The following are not allowed: space, #, %, &, *, {, }, \, :, <, >, ?, /, +, .	Los campos client_id o seller_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 o actualización de rutas 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.