En este artículo aprenderás a entender qué resuelven las APIs de Catálogo, cuáles son sus conceptos clave y qué endpoints usar en cada caso para gestionar tu inventario dentro de Botmaker.
Las APIs de Catálogo te permiten gestionar todo tu inventario de productos dentro de Botmaker para usarlo en las conversaciones con tus clientes: mostrar el catálogo en WhatsApp, recomendar productos desde un agente, manejar stock por tienda física, aplicar precios distintos según la zona geográfica y mantener todo sincronizado con plataformas externas como Meta (WhatsApp/Facebook). En lugar de cargar productos a mano, puedes integrarlas con tu e-commerce, ERP o sistema de inventario y mantener Botmaker actualizado automáticamente.
Puedes:
Requisitos previos
Acceso a tu cuenta de Botmaker con permisos para administrar catálogos. Credenciales de API válidas para autenticar tus requests. Si vas a publicar en WhatsApp, una integración con Meta configurada en tu cuenta.
Conceptos clave
Antes de operar con la API, conviene conocer los seis conceptos sobre los que se apoya toda la gestión del catálogo.
Catálogo: el contenedor principal. Suele haber uno por marca o por unidad de negocio. Categorías: agrupaciones de productos (por ejemplo, Bebidas, Postres, Promos). Sirven para filtrar y ordenar.
Productos: cada ítem que vendes. Se identifica por SKU e incluye nombre, descripción, precio, imágenes, disponibilidad y stock.
Tiendas (Stores): puntos de venta físicos o lógicos. Cada tienda tiene su propio inventario por SKU.
Zonas: áreas geográficas que agrupan tiendas. Sirven para aplicar precios diferentes según la región.
Esquemas de precio (Price Schemas): listas de precios que sobrescriben los precios base para una o varias zonas.
Todos los endpoints están bajo el prefijo /v2.0/ecommerce/catalogs. A continuación tienes las operaciones agrupadas por lo que necesitas hacer.
Paso 1: Arranca creando y administrando el catálogo
El catálogo es el punto de partida: es el contenedor donde vivirán tus categorías, productos, tiendas y precios.
Lo que quieres hacer | Endpoint |
Listar tus catálogos | GET /ecommerce/catalogs |
Crear un catálogo nuevo | POST /ecommerce/catalogs |
Paso 2: Organiza el catálogo con categorías
Las categorías agrupan tus productos para que sea más fácil filtrarlos y ordenarlos dentro de la conversación.
Lo que quieres hacer | Endpoint |
Ver las categorías de un catálogo | GET /ecommerce/catalogs/{catalogId}/categories |
Crear o actualizar categorías (en lote) | POST /ecommerce/catalogs/{catalogId}/categories |
Eliminar una categoría | DELETE /ecommerce/catalogs/{catalogId}/categories/{categoryCode} |
Paso 3: Carga y mantén tus productos
Esta es la operación más frecuente: el caso típico es que tu sistema le envíe a Botmaker el listado de productos actualizado cada cierto tiempo.
Lo que quieres hacer | Endpoint |
Listar o buscar productos del catálogo | GET /ecommerce/catalogs/{catalogId}/products |
Ver el detalle de un producto | GET /ecommerce/catalogs/{catalogId}/products/{sku} |
Crear o actualizar productos (varios por request) | POST /ecommerce/catalogs/{catalogId}/products |
Eliminar un producto | DELETE /ecommerce/catalogs/{catalogId}/products/{sku} |
Eliminar productos en lote (hasta 50 por request) | POST /ecommerce/catalogs/{catalogId}/products/batch/delete |
Paso 4: Gestiona tiendas e inventario por tienda
Si vendes desde más de un punto de venta y cada uno tiene su propio stock, esta es la sección que necesitas.
Lo que quieres hacer | Endpoint |
Listar tus tiendas | GET /ecommerce/catalogs/{catalogId}/stores |
Crear o actualizar tiendas con su inventario | POST /ecommerce/catalogs/{catalogId}/stores |
Eliminar una tienda | DELETE /ecommerce/catalogs/{catalogId}/stores/{code} |
Eliminar tiendas en lote | POST /ecommerce/catalogs/{catalogId}/stores/batch/delete |
Paso 5: Configura zonas geográficas y precios diferenciales
Si manejas precios distintos por región (CABA vs. interior, país A vs. país B, zona premium vs. estándar), combinas zonas con esquemas de precio.
Lo que quieres hacer | Endpoint |
Listar zonas | GET /ecommerce/catalogs/{catalogId}/zones |
Ver una zona | GET /ecommerce/catalogs/{catalogId}/zones/{zoneCode} |
Crear o actualizar zonas | POST /ecommerce/catalogs/{catalogId}/zones |
Eliminar una zona | DELETE /ecommerce/catalogs/{catalogId}/zones/{zoneCode} |
Eliminar zonas en lote | POST /ecommerce/catalogs/{catalogId}/zones/batch/delete |
Listar todos los esquemas de precio | GET /ecommerce/catalogs/{catalogId}/price-schemas |
Listar el esquema de precio de una zona | GET /ecommerce/catalogs/{catalogId}/price-schemas/{zoneCode} |
Crear o actualizar un esquema de precio | POST /ecommerce/catalogs/{catalogId}/price-schemas |
Paso 6: Integra con Meta (WhatsApp / Facebook)
Con esta integración, tu catálogo de Botmaker se publica automáticamente en WhatsApp y se puede mostrar dentro del chat.
Lo que quieres hacer | Endpoint |
Conectar tu catálogo a Meta | POST /ecommerce/catalogs/{catalogId}/platform-integrations |
Sincronizar (publicar productos hacia Meta) | POST /ecommerce/catalogs/{catalogId}/platform-integrations/{platform}/sync |
Desconectar la integración | DELETE /ecommerce/catalogs/{catalogId}/platform-integrations/{platform} |
Nota: después de crear o actualizar productos en Botmaker, tienes que llamar al endpoint de sync para que esos cambios se vean reflejados en WhatsApp/Meta. La sincronización es asincrónica: el endpoint devuelve un identificador para que puedas consultar el resultado.
Si te estás integrando por primera vez, este es el orden sugerido:
A futuro, mantén todo actualizado llamando a los POST de productos y tiendas cuando haya cambios en tu sistema, y dispara sync para reflejarlos en WhatsApp.
Recuerda visitar nuestro Centro de Ayuda para mayor información