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

Ligar o catálogo

Mostra a situação do catálogo da Meta, liga um catálogo ao número e desliga o espelhamento.

Consultar a situação do catálogo

Devolve se o catálogo está ligado e a contagem de itens por situação. Uma loja que nunca ligou um catálogo recebe enabled false e contagens zeradas.

GET/api/v1/admin/whatsapp-confluence/catalog/statusAdmin

Situação do catálogo da Meta

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/catalog/status" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Situação
json
{
  "enabled": true,
  "meta_catalog_id": "123456789012345",
  "last_full_sync_at": "2026-10-10T03:00:00Z",
  "items_pending": 4,
  "items_synced": 312,
  "items_error": 2,
  "items_deleted": 0
}

Campos da resposta

enabledboolean
O espelhamento está ligado.
meta_catalog_idstring
Id do catálogo na Meta. Vazio se nunca ligado.
last_full_sync_atstring
Última sincronização completa (RFC 3339). Ausente se nunca houve.
last_errorstring
Último erro de sincronização. Ausente quando não há.
items_pendinginteger
Itens aguardando envio.
items_syncedinteger
Itens sincronizados.
items_errorinteger
Itens com erro.
items_deletedinteger
Itens removidos.

Erros

StatusQuandoCorpo de exemplo
500Falha ao consultar.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}

Ligar um catálogo da Meta

Associa o catálogo ao número da loja e liga o espelhamento. A plataforma confere o id perguntando o nome do catálogo à Meta com a credencial da conta; se a conta não enxerga o catálogo, a ligação é recusada. Chamar de novo troca o catálogo.

POST/api/v1/admin/whatsapp-confluence/catalog/enableAdmin

Liga um catálogo da Meta

Corpo da requisição

meta_catalog_idstringobrigatório
Id do catálogo criado no Meta Commerce Manager. Obrigatório.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/catalog/enable" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"meta_catalog_id": "123456789012345"}'

Resposta

200Catálogo ligado
json
{
  "enabled": true
}

Campos da resposta

enabledboolean
Sempre true.

Erros

StatusQuandoCorpo de exemplo
400meta_catalog_id vazio ou JSON inválido.{"error":"meta_catalog_id required"}
502Nenhum número conectado, ou a Meta não achou o catálogo.{"error":"whatsappcoex: catalog validation failed: ..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Contas de teste

Contas de demonstração e teste pulam a conferência na Meta e aceitam qualquer id.

Desligar o espelhamento

Para de espelhar produtos. A ligação com o catálogo e os itens já sincronizados são mantidos; ligar de novo retoma de onde parou.

POST/api/v1/admin/whatsapp-confluence/catalog/disableAdmin

Desliga o espelhamento do catálogo

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp-confluence/catalog/disable" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Espelhamento desligado
json
{
  "enabled": false
}

Campos da resposta

enabledboolean
Sempre false.

Erros

StatusQuandoCorpo de exemplo
500Falha ao gravar.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
Não apaga nada na Meta

Os produtos já enviados continuam no catálogo da Meta; esta rota só interrompe novos envios.

Veja também

  • Sincronização do catálogo
Anterior
Campanhas
Próxima
Sincronização do catálogo
Nesta página
  • Consultar a situação do catálogo
  • Exemplo de requisição
  • Resposta
  • Erros
  • Ligar um catálogo da Meta
  • Exemplo de requisição
  • Resposta
  • Erros
  • Desligar o espelhamento
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também