Creación, actualización y eliminación de Catálogos Vía API + Vinculación a Meta
El primer paso es entender qué tipo de catálogo desea utilizar el cliente. Hoy en día en BM existen 2 tipos de catálogos, que son:
Catálogo vía E-commerce Botmaker
En este formato, la visualización del catálogo ocurre fuera de la experiencia de WhatsApp. Es decir, al interactuar con el bot, el usuario recibe un enlace externo que lo redirige a una página web con el catálogo completo.
Características principales:
- El catálogo se abre en una pestaña del navegador.
- Permite agregar una gran cantidad de productos y diferentes categorías.
- Es ideal para operaciones con un portafolio amplio y variado.
Ejemplo práctico: Catálogo vía E-commerce Botmaker (imagen a continuación).
Catálogo vía Meta
En este formato, la experiencia es completamente dentro de WhatsApp, sin necesidad de abrir enlaces externos. El usuario visualiza los productos directamente en la interfaz de conversación.
Limitaciones importantes:
- Es posible mostrar un máximo de 30 productos por categoría.
- No se recomienda usar múltiples categorías, ya que WhatsApp no unifica productos de diferentes categorías en el mismo carrito. Si el usuario navega entre categorías y agrega productos de más de una, el sistema crea carritos separados, lo que puede generar confusión o errores al finalizar el pedido.
Ejemplo práctico: (imagen a continuación).
Importante: Si el cliente opta por utilizar el Catálogo vía E-commerce Botmaker, no es necesario realizar la vinculación con Meta.
Sin embargo, si la elección es el Catálogo vía Meta (nativo de WhatsApp), es necesario contar con un catálogo activo en Meta para poder vincularlo al catálogo de Botmaker.
Es importante destacar que, una vez creado el catálogo en Botmaker, el siguiente paso será conectarlo a Meta.
En caso de que aún no exista un catálogo creado en Meta, la ejecución de la API de vinculación (Conectar catálogo BM al catálogo Meta) será responsable de generar automáticamente este catálogo; es decir, no es necesario crear manualmente un catálogo directamente en el WABA del cliente.
¿Cómo crear un catálogo en la API de Botmaker?
En el entorno deseado, sigue estos pasos:
- 1. Accede a: https://go.botmaker.com/#/api/
- 2. En la pestaña "Credenciales", crea un access-token para tu uso:
Ahora, realiza un ejercicio para listar los catálogos que ya han sido creados en el entorno:
- Encuentra el endpoint "List Catalogs".
- Inserta tu access-token.
- Envía una solicitud a la API.
Siguiendo estos pasos, podrás gestionar los catálogos existentes y continuar con otras operaciones según sea necesario.
Después del ejercicio, vamos crear el Catálogo:
- Encuentra el endpoint "Create Catalog".
- Inserta tu access-token.
- En el cuerpo de la solicitud (body), simplemente edita el contenido que está entre comillas "string":
- title: "mi-titulo"
- description: "mi-descripcion"
- Envía la solicitud, ¡y listo! Tu catálogo será creado.
Puedes consultar el ID del catálogo recién creado utilizando el endpoint "List Catalogs", como se explicó en el tema anterior.
Ahora que el catálogo de Botmaker ha sido creado, puedes agregar o actualizar los productos que pertenecen a él. Sin embargo, si prefieres utilizar el método de visualización de Lista de Productos nativa de WhatsApp, es necesario realizar una sincronización con un catálogo creado en Meta (dentro del Business Manager).
Si deseas utilizar la Lista de Productos nativa de WhatsApp, sigue estos pasos:
¿Cómo crear el catálogo Botmaker en un catálogo Meta?
Para ello, debe:
- Acceder a Business Manager;
- Acceder al área Fuente de datos;
- Crear un catálogo;
- Acceder a la WABA deseada;
- En el menú lateral > Herramientas de la cuenta > Catálogo;
- Conectar catálogo > Seleccionar el catálogo recién creado o deseado.
¿Cómo vincular el catálogo de Meta al catálogo de Botmaker?
Consolide la siguiente información:
- ID del catálogo Botmaker (a través del punto final List Catalogs);
- ID del catálogo Meta (a través de Business Manager).
Siga los siguientes pasos:
- Acceda al punto final Connect to external catalog platform (Conectarse a la plataforma de catálogo externo);
- En el elemento catalogId, introduzca el ID del catálogo Botmaker;
- En el cuerpo, solo edite el texto «string» por «ID del catálogo Meta».
🎉 ¡Listo! ¡Ahora tu catálogo está vinculado!
Puede consultar el enlace mediante el punto final List Catalogs. Ahora su catálogo aparecerá como integrado y mostrará el ID del catálogo meta al que está vinculado.
Añadir productos
Independientemente de si tu catálogo está vinculado a Meta o no, puedes añadir productos utilizando los siguientes puntos finales de la API de Botmaker:
- Creación/Actualización de una categoría (Crear/Actualizar categorías)
Después de sincronizar el catálogo Botmaker y el catálogo Meta, antes de añadir los productos al mismo, es necesario crear una categoría de productos y, para ello:
- endpoint: https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/categories
- Parameters: {catalogId} = ID del catálogo creado en Botmaker
- Body:
{
"categories": [
{
"code": "string",
"title": "string",
"description": "string",
"iconImageUrl": "string",
"parentCategoryCode": "string",
"order": 0
}
]
}
- Creación/Actualización de productos (Create/Update products)
A continuación, añada los productos deseados en la categoría que acaba de crear y para ello:
- endpoint: https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/products
- Parameters: {catalogId} = ID del catálogo creado en Botmaker
- Body:
{
"products": [
{
"sku": "string",
"title": "string",
"description": "string",
"brand": "string",
"condition": "NEW",
"link": "string",
"image": "https://www.company.com/products/product-name.png",
"additionalImages": [
"https://www.company.com/products/product-name-detail-1.png",
"https://www.company.com/products/product-name-detail-2.png"
],
"price": 0,
"priceAsString": "string",
"salePrice": 0,
"salePriceAsString": "string",
"salePeriods": [
{
"startDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"endDate": "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
"salePrice": 0
}
],
"currency": "ARS",
"availability": "IN_STOCK",
"inventory": 1,
"color": "string",
"size": "string",
"gender": "FEMALE",
"categories": [
"string"
],
"group": "polo_shirt",
"order": 0,
"tags": [
"green",
"medium"
],
"variants": [
{
"sku": "101",
"productId": "501",
"variantProperties": {
"Color": [
"Red"
]
}
},
{
"sku": "102",
"productId": "501",
"variantProperties": {
"Color": [
"Blue"
]
}
}
],
"options": [
{
"hidden": false,
"values": [
{
"image": "",
"hidden": false,
"optionCode": "Color",
"extra": false,
"id": "White",
"title": "White"
},
{
"image": "",
"hidden": false,
"optionCode": "Color",
"extra": false,
"id": "Graphite",
"title": "Graphite"
},
{
"image": "",
"hidden": false,
"optionCode": "Color",
"extra": false,
"id": "Apricot",
"title": "Apricot"
}
],
"extra": false,
"id": "Color",
"type": "SELECT",
"title": "Color"
}
]
}
]
}
- Sincronizar el catálogo BM con el catálogo de Meta (Sync catalog with external catalog platform)
Para finalizar la creación del nuevo catálogo, es esencial sincronizar lo que se ha creado en la API Botmaker con el catálogo de destino, de lo contrario, el catálogo no funcionará con el diseño de Whatsapp, sino con la versión de comercio electrónico de Botmaker. Y para realizar la sincronización:
- endpoint:https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/platform-integrations/{platformOrPlatformCatalogId}/sync
- Parameters: {catalogId} = ID del catálogo creado en Botmaker
{platformOrPlatformCatalogId} = meta / platform
¡El catálogo ya está creado y listo para usar en el flujo!
Paso a paso para eliminar productos o categorías:
- Eliminar categoría (Delete products)
- endpoint:https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/categories/{categoryCode}
- Parameters: {catalogId} = ID del catálogo creado en Botmaker
{categoryCode} = ID de la categoría que desea eliminar
- Deletar Produtos (Delete category)
- endpoint:https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/products/batch/delete
- Parameters:{catalogId} = ID del catálogo creado en Botmaker
- Body:
{
"skus": [
"LG20k",
"LG30k"
]
}
IMPORTANTE: Siempre que se cree, actualice o elimine cualquier elemento del catálogo, es decir, si se utiliza cualquier punto final de productos o categorías, es obligatorio volver a sincronizar el catálogo de Botmaker con el catálogo de Meta, en «Sincronizar el catálogo de BM con el catálogo de Meta (Sync catalog with external catalog platform)».