VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: catálogo na Meta

Produtos e templates

Busca produtos para enviar na conversa e lista os templates de mensagem aprovados.

Buscar produtos

Alimenta o seletor de produtos da caixa de entrada. A busca respeita o catálogo do seller dono do número: um token de seller vê o catálogo dele; em loja marketplace (marketplace_all_sellers ligado) o administrador vê o catálogo de todos.

GET/api/v1/admin/whatsapp-confluence/productsAdmin

Busca produtos para o seletor

Parâmetros de consulta

qstring
Texto da busca. search é aceito como apelido.
per_pageintegerpadrão: 40
Itens por página, de 1 a 50 (fora disso, 40).
pageintegerpadrão: 1
Página, a partir de 1.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/products?q=camiseta&per_page=10" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Produtos
json
{
  "products": [
    {
      "id": "0b6f9d52-8a7e-4b1c-9d3a-52e1f4a7c610",
      "name": "Camiseta Azul",
      "price_cents": 5990
    }
  ]
}

Campos da resposta

productsarray
Produtos encontrados. Os campos de cada item são os da busca de produtos da plataforma (por exemplo id, name, price_cents em centavos).

Erros

StatusQuandoCorpo de exemplo
502A busca de produtos falhou.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Vazio para o administrador

Se o token é de administrador, a loja não é marketplace e o número não pertence a um seller, a lista vem vazia e o status é 200. Isso não é falta de produtos: o escopo não foi definido.

Listar os templates

Devolve a cópia local dos templates da conta. Os templates são criados e aprovados na Meta (Gerenciador do WhatsApp); aqui você só os lê. Com sync=1, a plataforma atualiza a cópia com a Meta antes de responder.

GET/api/v1/admin/whatsapp-confluence/templatesAdmin

Lista templates de mensagem

Parâmetros de consulta

syncstring
1
1 atualiza os templates na Meta antes de listar. Qualquer outro valor é ignorado.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/templates?sync=1" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Templates
json
{
  "templates": [
    {
      "id": 1,
      "name": "pedido_confirmado",
      "language": "pt_BR",
      "category": "UTILITY",
      "status": "A",
      "components": [
        {
          "type": "BODY",
          "text": "Olá {{1}}, seu pedido foi confirmado."
        }
      ],
      "quality_score": "GREEN",
      "synced_at": "2026-10-09T13:05:00Z"
    }
  ]
}
200Atualização falhou, lista local devolvida
json
{
  "templates": [
    {
      "id": 1,
      "name": "pedido_confirmado",
      "language": "pt_BR",
      "category": "UTILITY",
      "status": "A",
      "components": [
        {
          "type": "BODY",
          "text": "Olá {{1}}, seu pedido foi confirmado."
        }
      ],
      "quality_score": "GREEN",
      "synced_at": "2026-10-09T13:05:00Z"
    }
  ],
  "sync_error": "..."
}

Campos da resposta

templatesarray
Templates.
templates[].idinteger
Id local.
templates[].namestring
Nome do template, usado em Enviar um template e nas campanhas.
templates[].languagestring
Idioma (pt_BR).
templates[].categorystring
MARKETINGUTILITYAUTHENTICATION
Categoria cobrada pela Meta.
templates[].statusstring
APRX
Situação.
templates[].rejection_reasonstring
Motivo da rejeição. Ausente se não foi rejeitado.
templates[].componentsarray
Estrutura do template no formato da Meta (corpo, cabeçalho, botões). {{1}}, {{2}} são as variáveis.
templates[].quality_scorestring
Nota de qualidade da Meta. Ausente se não houver.
templates[].synced_atstring
Última atualização com a Meta.
sync_errorstring
Só aparece quando sync=1 falhou; a lista devolvida é a local, possivelmente velha.

Erros

StatusQuandoCorpo de exemplo
500Falha ao ler a lista local.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Falha de atualização não é erro HTTP

Se a Meta não responder, o status continua 200 e o campo sync_error explica. Teste a presença dele.

Veja também

  • Responder
  • Campanhas
Anterior
Sincronização do catálogo
Próxima
Resultados e orçamento
Nesta página
  • Buscar produtos
  • Exemplo de requisição
  • Resposta
  • Erros
  • Listar os templates
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também