Criação, Atualização e Exclusão de Catálogos Via API + Vinculação à Meta
O primeiro passo é entender qual o tipo de catálogo que o cliente deseja utilizando, hoje na BM existe 2 tipos de catálogos, sendo eles:
- Catálogo via E-commerce Botmaker
Neste formato, a visualização do catálogo ocorre fora da experiência do WhatsApp. Ou seja, ao interagir com o bot, o usuário recebe um link externo que o redireciona para uma página web com o catálogo completo.
Principais características:
- O catálogo é aberto em uma aba do navegador.
- Permite adicionar uma grande quantidade de produtos e categorias diferentes.
- É ideal para operações com portfólio amplo e variado.
Exemplo prático: Catálogo via E-commerce Botmaker (print abaixo).
- Catálogo via Meta
Neste formato, a experiência é inteiramente dentro do WhatsApp, sem necessidade de abrir links externos. O usuário visualiza os produtos diretamente na interface da conversa.
Limitações importantes:
- É possível exibir no máximo 30 produtos por categoria.
- Não é recomendado usar múltiplas categorias, pois o WhatsApp não unifica produtos de categorias diferentes no mesmo carrinho. Caso o usuário navegue entre categorias e adicione produtos de mais de uma, o sistema cria carrinhos separados, o que pode gerar confusão ou falhas na finalização do pedido.
Exemplo prático: (print abaixo).
IMPORTANTE: Caso o cliente opte por utilizar o Catálogo via E-commerce Botmaker, não é necessário realizar a vinculação com a Meta.
No entanto, se a escolha for pelo Catálogo via Meta (nativo do WhatsApp), é necessário que haja um catálogo ativo na Meta para que a vinculação com o catálogo da Botmaker possa ser feita.
Vale destacar que, assim que o catálogo for criado na Botmaker, o próximo passo será conectá-lo à Meta.
Caso ainda não exista um catálogo criado na Meta, a própria execução da API de vinculação (Conectar catálogo BM ao catálogo Meta (Connect to external catalog platform) será responsável por gerar automaticamente esse catálogo, ou seja, não é necessário criar manualmente um catálogo diretamente no WABA do cliente.
Como criar um catálogo na API Botmaker?
- No ambiente desejado, acesse: https://go.botmaker.com/#/api/
- Na aba “Credenciais”, crie um access-token para seu uso:
🧩 Agora, faça um exercício de listagem dos catálogos que já foram criados no ambiente:
- Encontre o endpoint List Catalogs;
- Insira o seu access-token;
- Envie uma requisição para a API.
Após o exercício, vamos criar o Catálogo:
- Encontre o endpoint Create Catalog;
- Insira o seu access-token;
- No body, basta editar o conteúdo que está entre aspas “string”:
- title: “meu-titulo”
- description: “minha-descricao”
Basta enviar a requisição e pronto! Seu catálogo será criado e você pode consultar o ID dele pelo endpoint List Catalogs como apresentado no tópico acima.
Agora que o catálogo Botmaker foi criado, você já pode adicionar/atualizar os produtos pertencentes a ele, ou então, caso opte por utilizar o método de exibição de Lista de Produtos nativa do WhatsApp, é necessário realizar a sincronização com um catálogo criado na Meta (dentro do Business Manager).
Caso deseje utilizar a Lista de Produtos nativa do WhatsApp, siga os passos abaixo:
Como criar o Catálogo Botmaker à um Catálogo Meta?
Para isso, você deve:
- Acessar o Business Manager;
- Acessar a área Fonte de dados;
- Criar um catálogo;
- Acessar a WABA desejada;
- No menu lateral > Ferramentas da conta > Catálogo;
- Conectar catálogo > Selecionar o catálogo recém criado ou desejado.
Como vincular o catálogo da Meta ao catálogo Botmaker?
Consolide as seguintes informações:
- ID Catálogo Botmaker (via endpoint List Catalogs);
- ID Catálogo Meta (via Business Manager).
Siga os seguintes passos:
- Acesse o endpoint Connect to external catalog platform;
- No item catalogId, insira o ID do Catálogo Botmaker;
- No body, apenas edite o texto “string” por “ID do Catálogo Meta”.
🎉 Pronto! Agora o seu catálogo está vinculado!
Você pode consultar a vinculação pelo endpoint List Catalogs. Agora o seu catálogo será exibido como integrado e exibirá o ID do Catálogo Meta ao qual ele está vinculado.
Adição de Produtos
Independente se o seu catálogo está vinculado à Meta, ou não, você pode adicionar produtos utilizando os seguintes endpoints da API Botmaker:
- Criação/Atualização de uma Categoria (Create/Update categories)
Após a sincronização do catálogo Botmaker e catálogo Meta, antes de adicionar os produtos nele, é necessário realizar a criação de uma categoria dos produtos e para isso:
- endpoint: https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/categories
- Parameters: {catalogId} = ID do catálogo criado na Botmaker
- Body:
{
"categories": [
{
"code": "string",
"title": "string",
"description": "string",
"iconImageUrl": "string",
"parentCategoryCode": "string",
"order": 0
}
]
}
- Criação/Atualização dos produtos (Create/Update products)
Em seguida, adicionar os produtos desejados na categoria que acabou de ser criada e para isso:
- endpoint: https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/products
- Parameters: {catalogId} = ID do catálogo criado na 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 catálogo BM ao catálogo da Meta (Sync catalog with external catalog platform)
Para finalizar a criação do catálogo novo é essencial a sincronização do que foi criado na API Botmaker ao catálogo da meta, caso contrário o catálogo não irá funcionar com o layout Whatsapp e sim com a versão do ecommerce Botmaker. E para realizar a sincronização:
- endpoint:https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/platform-integrations/{platformOrPlatformCatalogId}/sync
- Parameters: {catalogId} = ID do catálogo criado na Botmaker
{platformOrPlatformCatalogId} = meta / platform
Pronto o catálogo está criado e pronto para usar no fluxo!
Passo a Passo para Exclusão de Produtos ou Categorias:
- Deletar Categoria (Delete products)
- endpoint:https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/categories/{categoryCode}
- Parameters: {catalogId} = ID do catálogo criado na Botmaker
{categoryCode} = ID da categoria que deseja deletar
- Deletar Produtos (Delete category)
- endpoint:https://api.botmaker.com/v2.0/ecommerce/catalogs/{catalogId}/products/batch/delete
- Parameters:{catalogId} = ID do catálogo criado na Botmaker
- Body:
{
"skus": [
"LG20k",
"LG30k"
]
}
IMPORTANTE: Sempre que for não só criado, mas atualizado ou deletado qualquer coisa no catálogo, ou seja, se for usado qualquer endpoint de produtos ou categorias, obrigatoriamente é necessário realizar a sincronização novamente do catálogo Botmaker com o catálogo Meta, em “Sincronizar catálogo BM ao catálogo da Meta (Sync catalog with external catalog platform)”.