Uso de la API

La Delivery Capacity API permite calcular la fecha de entrega disponible para un grupo de productos mediante el endpoint:

POST /delivery/capacity

Este endpoint calcula la fecha de entrega basándose en los despachos que se generarían, utilizando lógica de capacidad.

Endpoint

POST /delivery/capacity

URL Base

Autenticación

La API utiliza autenticación mediante API Key.

Header requerido:

Authorization: Bearer <api-key>

Headers requeridos

Límite de la API

La API permite:

Múltiples productos por request

Consideraciones importantes

• El procesamiento es sincrónico
• Se retorna la respuesta en el mismo request
• La capacidad se evalúa en tiempo real según la disponibilidad
• Campos como nodos, identificadores de ruta y fechas internas se calculan dentro del servicio y no deben enviarse en el request

Estructura del Request

El request debe incluir los datos de la solicitud de fecha de entrega:

- purchaseDate (requerido)
- items (requerido)
- isLastRoute (opcional)
- isPurchaseOrderDeliveryDateRequest (opcional)

Ejemplo de referencia

{
  "purchaseDate": "2024-01-15",
  "isLastRoute": false,
  "isPurchaseOrderDeliveryDateRequest": false,
  "items": [
    {
      "origin": "LIMA01",
      "entityType": "CD",
      "skuCode": "20054995",
      "line": "FASHION",
      "zone": "SPSA-ZN-125",
      "zoneByChannel": "ECOMMERCE_ZONA_125",
      "dispatchType": "NORMAL",
      "quantity": 5,
      "measurable": "UN",
      "destination": "LIMA",
      "units": 5,
      "division": "TEXTIL",
      "province": "LIMA",
      "weight": 0.8,
      "hasFreightAttributeConfiguration": false,
      "attributes": [
        {
          "attribute": "TEMPERATURA",
          "attributeValue": "AMBIENTE",
          "attributeCode": "TEMP_AMB"
        }
      ],
      "latitude": -12.092,
      "longitude": -77.042,
      "saleChannel": "ecommerce",
      "presentationCode": "UN",
      "entityCode": "ENT-001",
      "groupName": "GRUPO-LIMA",
      "deliveryMode": "HOME_DELIVERY"
    }
  ]
}

Validaciones por campo

Campos obligatorios

Los siguientes campos son requeridos:

• purchaseDate (formato: YYYY-MM-DD)
• items (array no vacío)

Campos del item (DispatchDTO)

Campos adicionales soportados en items[]

Descripción de los atributos del response

Información de fecha de entrega

Estados y tipos válidos

entityType

CD -> Centro de Distribución
TD -> Tienda
PRV -> Proveedor
SELLER -> Vendedor

deliveryMode

HOME_DELIVERY -> Entrega a domicilio
STORE_WITHDRAWAL -> Retiro en tienda

dispatchType

NORMAL -> Despacho normal
EXPRESS -> Despacho express

Flujo interno de cálculo de fecha de entrega

1. Recepción del request con grupo de productos
2. Validación de estructura JSON
3. Validación de reglas de negocio
4. Cálculo de despachos generados
5. Evaluación de capacidad de cada despacho
6. Determinación de fechas de entrega
7. Generación de trazabilidad
8. Retorno de respuesta

Diagrama de flujo

El siguiente diagrama describe el flujo de cálculo de fecha de entrega:

Códigos de respuesta

El archivo swagger de la API se puede consultar en el siguiente enlace: Swagger