Crear Rutas

Descripción

Permite crear una o múltiples rutas de visita para vendedores 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.

Las rutas definen qué clientes debe visitar un vendedor, en qué día de la semana y con qué frecuencia.

El sistema utiliza una operación MERGE que solo inserta rutas nuevas. Si una ruta con la misma combinación de client_code, seller_code y day ya existe, será ignorada (no se actualizará).

---

Endpoint

POST /api/routes/batch-create

---

Headers

Header	Valor	Descripción
Content-Type	application/json	Especifica que el contenido es JSON

---

Body (JSON)

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 Requeridos

Estos campos son obligatorios en cada objeto del array:

Campo	Tipo	Longitud	Descripción
client_code	String	Max 18	Código único del cliente a visitar
seller_code	String	Max 18	Código único del vendedor asignado
day	Decimal	(1, 0)	Día de la semana (1=Lunes, 2=Martes, …, 7=Domingo)
frequency	Integer	-	Frecuencia de visita (ej: 1=semanal, 2=quincenal, 4=mensual)

Formato de tipos de datos

• String: Cadena de texto. La longitud indica el máximo de caracteres permitidos.
• Decimal (p, s): Número decimal donde p es la precisión total (dígitos enteros + decimales) y s es la escala (dígitos decimales).
  • Ejemplo: Decimal (1, 0) permite un solo dígito entero sin decimales (valores del 1 al 9)
• Integer: Número entero sin decimales.

---

Campos Opcionales

Estos campos pueden incluirse opcionalmente en cada objeto:

Campo	Tipo	Longitud	Descripción
sequence	Integer	-	Orden de visita del cliente dentro del día (secuencia)

---

Ejemplo de Petición

A continuación se muestra un ejemplo completo de creación de rutas:

curl -X POST "https://your-api-url/api/routes/batch-create" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "client_code": "CLI-001",
      "seller_code": "VEND-001",
      "day": 1,
      "frequency": 1,
      "sequence": 1
    },
    {
      "client_code": "CLI-002",
      "seller_code": "VEND-001",
      "day": 1,
      "frequency": 1,
      "sequence": 2
    },
    {
      "client_code": "CLI-003",
      "seller_code": "VEND-001",
      "day": 2,
      "frequency": 2,
      "sequence": 1
    }
  ]'

Ejemplo con múltiples días

curl -X POST "https://your-api-url/api/routes/batch-create" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "client_code": "CLI-100",
      "seller_code": "VEND-005",
      "day": 1,
      "frequency": 1
    },
    {
      "client_code": "CLI-100",
      "seller_code": "VEND-005",
      "day": 3,
      "frequency": 1
    },
    {
      "client_code": "CLI-100",
      "seller_code": "VEND-005",
      "day": 5,
      "frequency": 1
    }
  ]'

---

Respuesta Exitosa

Status Code: 201 Created

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

Importante

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

---

Respuestas de Error

Error 400 - JSON Inválido

Se produce cuando el body de la petición no contiene un JSON válido.

Status Code: 400 Bad Request

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

---

Error 400 - Body No Es Un Array

Se produce cuando el body no es un array de objetos.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": null,
      "field": null,
      "message": "Request body must be an array"
    }
  ]
}

---

Error 400 - Array Vacío

Se produce cuando el array no contiene ningún elemento.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": null,
      "field": null,
      "message": "Request body cannot be empty"
    }
  ]
}

---

Error 400 - Excede Límite de Batch

Se produce cuando el array contiene más de 10,000 elementos.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": null,
      "field": null,
      "message": "Array exceeds maximum limit of 10000 items"
    }
  ]
}

---

Error 400 - Errores de Validación por Item

Se produce cuando uno o más items del array tienen errores de validación. Cada error incluye el índice del item en el array.

Status Code: 400 Bad Request

{
  "statusCode": 400,
  "errors": [
    {
      "index": 0,
      "errors": [
        {
          "field": "client_code",
          "message": "Field is required"
        },
        {
          "field": "day",
          "message": "Field must be of type decimal"
        }
      ]
    },
    {
      "index": 2,
      "errors": [
        {
          "field": "seller_code",
          "message": "Field exceeds maximum length of 18 characters"
        }
      ]
    }
  ]
}

Tipos de errores de validación por campo

Error	Descripción
Field is required	El campo obligatorio no fue enviado o está vacío
Field must be a string	El valor no es una cadena de texto
Field must be of type integer	El valor no es un número entero válido
Field must be of type decimal	El valor no es un número decimal válido
Field must be a valid decimal (e.g., 1.5, 10.25)	El formato del decimal es inválido
Field exceeds maximum length of X characters	La cadena excede la longitud máxima permitida
Field exceeds maximum of X integer digits	El número excede los dígitos enteros permitidos
Field exceeds maximum of X decimal places	El número excede los decimales permitidos
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

---

Error 500 - Error de Validación Inesperado

Se produce cuando ocurre un error inesperado durante el proceso de validación de datos.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Unexpected validation error: [descripción del error]"
    }
  ]
}

---

Error 500 - Error de Conexión a Base de Datos

Se produce cuando hay problemas de conexión con la base de datos.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Error connecting to database: [descripción del error]"
    }
  ]
}

---

Error 500 - Error de Operación en Base de Datos

Se produce cuando la operación en la base de datos falla durante la ejecución.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Database operation failed: [descripción del error]"
    }
  ]
}

---

Error 500 - Error Inesperado

Se produce ante cualquier error no controlado durante el procesamiento.

Status Code: 500 Internal Server Error

{
  "statusCode": 500,
  "errors": [
    {
      "message": "Unexpected error: [descripción del error]"
    }
  ]
}

---

Códigos de Estado HTTP

Código	Descripción
201	Rutas creadas exitosamente
400	Error en la estructura o validación de los datos
500	Error interno del servidor

Para más información sobre los códigos de estado, consulta la sección de Códigos de estado HTTP.

---

Notas Importantes

• El endpoint utiliza una operación MERGE que solo inserta registros nuevos.
• Las rutas existentes (misma combinación de client_code, seller_code y day) son ignoradas sin generar error.
• Todos los campos de texto son sensibles a mayúsculas/minúsculas.
• El campo day representa el día de la semana donde 1=Lunes y 7=Domingo.
• La fecha de creación (FECHA_CREA) se asigna automáticamente por el sistema.
• Se recomienda enviar lotes de máximo 1,000 registros para un mejor rendimiento.
• El campo sequence es útil para definir el orden en que el vendedor debe visitar a los clientes en un día específico.