LogoDAD Dev Docs

Uso de la API

Documentación de uso de la API de carga masiva de productos

Uso de la API

La Products Upload API permite realizar la carga masiva de productos mediante el endpoint:

POST /load-products

Este endpoint permite enviar hasta 3000 productos por solicitud en formato JSON.

Los productos son validados y enviados a procesamiento asíncrono dentro del sistema.


Endpoint

POST /load-products

URL Base

https://business-irdgco-products-upload.cloudintercorpretail-qa.pe/api/business-irdgco-products-upload/v1

Autenticación

La API utiliza autenticación mediante Bearer Token (JWT).

Header requerido:

Authorization: Bearer <token>

Headers requeridos

HeaderDescripción
AuthorizationToken JWT de autenticación
Content-Typeapplication/json

Límite de la API

La API permite:

Máximo 3000 productos por request

Si se supera este límite se devuelve:

400 - El número máximo de productos por carga es 3000

Consideraciones importantes

  • El procesamiento es asíncrono
  • El response 200 NO garantiza persistencia final
  • Los errores pueden ser parciales

Estructura del Request

El cuerpo de la solicitud debe contener:

products[]

Lista de productos a procesar.


Ejemplo de referencia

{
  "products": [
    {
      "productCode": "SPSA-100002",
      "skuCode": "20054995",
      "eanCode": "9421226",
      "description": "MITHOS PANT D FT NEGRO T.26-34 TT",
      "price": 15.5,
      "length": 30,
      "width": 20,
      "height": 5,
      "weight": 0.8,
      "productType": "ST",
      "dispatchType": "NORMAL",
      "unitMeasurement": "UN",
      "unitedNationsCode": "00601059",
      "hierarchyCode": "SPSA-F0425",
      "taxSale": "T",
      "productPmmStatus": "5",
      "dateUpdate": "2021-03-01 09:00:00",
      "isEcommerce": "T",
      "measurable": "F",
      "conversionFactor": 1,
      "barcodes": [
        {
          "productCode": "SPSA-100002",
          "eanCode": "9421226",
          "indicator": "PRINCIPAL"
        }
      ],
      "hierarchies": [
        {
          "hierarchyCode": "SPSA-F0425",
          "hierarchyLevel": 1,
          "hierarchyName": "Ropa"
        }
      ],
      "lstAttributes": [
        {
          "attributeType": "COLOR",
          "parentAttributeCode": "GENERAL",
          "attributeCode": "NEGRO",
          "attributeDescription": "Color negro",
          "productCode": "SPSA-100002"
        }
      ]
    }
  ]
}

Validaciones por campo

Campos obligatorios

Los siguientes campos son requeridos por producto:

  • productCode
  • skuCode
  • eanCode
  • description
  • price
  • length
  • width
  • height
  • weight
  • productType
  • unitMeasurement
  • unitedNationsCode
  • hierarchyCode
  • taxSale
  • productPmmStatus
  • dateUpdate
  • isEcommerce
  • measurable
  • conversionFactor
  • barcodes
  • hierarchies
  • lstAttributes

Descripción de los atributos del request

Definición de campos importantes

Identificadores

CampoDescripción
productCodeCódigo único del producto a nivel empresa
skuCodeCódigo SKU del producto
eanCodeCódigo de barras principal del producto

Descripción

CampoDescripción
descriptionDescripción del producto
  • Tamaño máximo recomendado: 255 caracteres

Dimensiones del producto

CampoDescripciónUnidad
lengthLargo del productocm
widthAncho del productocm
heightAlto del productocm
weightPeso del productokg

Catálogos de negocio

productType

Tipo de producto definido por el sistema maestro.

Ejemplo:

ST

unitMeasurement

Unidad de medida del producto.

Ejemplos:

UN -> Unidad
KG -> Kilogramo
LT -> Litro
ML -> Mililitro

dispatchType

Tipo de despacho del producto.

Valores posibles:

NORMAL
EXPRESS
INTERNATIONAL

Impuestos

taxSale

T -> Afecto a impuesto
F -> No afecto

Estado del producto

productPmmStatus

Ejemplo:

5 -> Producto activo

Conversión de unidades

conversionFactor

Ejemplo:

1 caja = 12 unidades
conversionFactor = 12

Flags del producto

isEcommerce

T -> Habilitado en ecommerce
F -> No disponible en ecommerce

measurable

T -> Producto medible
F -> Producto unitario

Objetos relacionados

barcodes

Lista de códigos de barras asociados al producto.

hierarchies

Lista de jerarquías del producto.

lstAttributes

Lista de atributos adicionales.


Códigos de respuesta

CódigoDescripción
200Procesamiento correcto
400Error en la solicitud
401No autorizado
403Prohibido
500Error interno

Flujo interno de procesamiento

  1. Recepción del request
  2. Validación de estructura JSON
  3. Validación de reglas de negocio
  4. Publicación en sistema de mensajería (PubSub)
  5. Procesamiento asíncrono
  6. Persistencia en sistemas downstream
  7. Generación de resultados

Ejemplo de flujo

El siguiente diagrama describe el flujo interno de procesamiento de la API:

Swagger

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

On this page