Integración con VTEX

A continuación se detallan las APIs para Integrar Catálogo (Categoría, Marca, Producto y SKU), Precio y Stock desde el ERP (u otro sistema legado del cliente) hacia VTEX a través de JANIS.

Previo a poder realizar la integración, es necesario tener las configuraciones iniciales de la cuenta VTEX.

Aclaraciones previas:

• Previo a dar de alta un producto, es requerido que esté creada la Marca y la Categoría.
• Previo a dar de alta un precio u stock, es requerido que esté creado el Producto y el SKU.
  Los productos se venden al relacionarlos a Sales Chanels
  Los precios se asignan a price sheets :white_tick:, pero los price sheets se asignan a Sales Channels
  El stock se relaciona Warehouse que a su ves se relaciona a Sales Channels
• Los IDs de Producto, SKU, Marca, etc. serán definidos por VTEX al momento de la creación desde JANIS. Es decir, que no es posible definir un VTEX ID previo a la creación.

1. API de Categoría:

Link a la documentación: https://docs.janis.in/v2/service/catalog#operation/saveCategoryBatch

2. API de Marca:

Link a la documentación: https://docs.janis.in/v2/service/catalog#operation/saveBrandBatch

3. API de Producto:

Link a la documentación: https://docs.janis.in/v2/service/catalog#operation/saveProductBatch

Para Productos, el Sale Channel que viaje dentro del campo salesChannelsReferenceIds debe estar asociado previamente a una Cuenta de VTEX.

4. API de SKU:

Link a la documentación: https://docs.janis.in/v2/service/catalog#operation/saveSkuBatch

📘

Reintentos de Productos + SKUs

Tanto para Productos como para SKUs, aquellos registros que fallen se reintentará su publicación hasta 3 veces de manera automática.

En los casos en que un SKU falle por faltarle su producto, si este error ocurrió por la carga en paralelo de ambas entidades, al momento de publicarse el producto, ese mismo proceso (Publicación de Producto) reintentará la publicación de todos los SKUs relacionados.

Por ejemplo, si se quiere acceder a los registros de skus pendientes de publicacion. se debe hacer click aquí.

En el browse se pueden visualizar 2 status (Siempre que existan registros pendientes de publicarse):

• Stopped Publish: No hay ningún proceso corriendo al momento de cargar la vista.
• Pending Publish: Hay un proceso de publicación corriendo

Además, dentro de las entidades de Producto y SKU se encotrará el botón de Retry publish errorr para ejectuar la acciones de reintentar la publicación frente a cualquier escenario de error.

📘

Definir VTEX ID

Es posible definir por integración el VTEX ID con el que se va a crear un producto y/o SKU hacia VTEX.

Para esto, se debe enviar el VTEX ID que con el que se quiera publicar el producto/SKU dentro del campo en la API commerceId en API de Producto y SKU.

📘

Sugerencia de volumen y frecuencia de requests

Para Producto y SKU se sugiere el siguiente volumen:

• 500 registros por request
• 1 request cada 20 segundos

5. API de Imágenes:

Link a la documentación: https://docs.janisqa.in/v2/service/catalog#operation/saveSkuImageBatch
*Las URLs de las imágenes deben ser públicas.

6. API de Precio:

Link a la documentación: https://docs.janis.in/v2/service/pricing#operation/priceBatchCreate

Dentro de la API de Precio, se notará que está el campo priceSheetReferenceId. El priceSheet se puede crear de forma manual en Janis o bien, por API.

A su vez, el Price Sheets debe estar asociado a un Sale Channel asociado previamente a una cuenta VTEX.

📘

Sugerencia de volumen y frecuencia de requests

Para Precio se sugiere el siguiente volumen:

• 1000 registros por request
• 1 request cada 15 segundos

7. API de Stock:

Link a la documentación: https://docs.janis.in/v2/service/wms#operation/createStockBatch

Asu vez, el Warehouse debe estar asociado a un Sale Channel asociado previamente a una cuenta VTEX.

📘

Control de publicación de Stock hacia VTEX

Mediante la entidad de Stock Publish Queue se pueden monitorear los registros de stock que se notifican hacia VTEX. Cada registro tiene un límite de 5 intentos de publicación.

📘

Sugerencia de volumen y frecuencia de requests

Para Stock se sugiere el siguiente volumen:

• 1000 registros por request
• 1 request cada 15 segundos