VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Canal e catálogo do WhatsApp

Os ajustes do canal de WhatsApp do seller: horário, catálogo publicado na Meta, modelos de mensagem e a mini-loja que o cliente abre pelo WhatsApp.

Esta seção reúne o que o seller configura em volta da conversa: quando atende (horário), o que aparece no catálogo nativo do WhatsApp, quais modelos de mensagem pode usar para falar primeiro com o cliente e como é a mini-loja aberta por link.

Quatro conceitos novos:

  • Catálogo da Meta: uma lista de produtos publicada no Gerenciador de Catálogo da Meta, que o WhatsApp mostra dentro da conversa. A plataforma copia os produtos do seller para lá (só no sentido plataforma para Meta).
  • Modelo de mensagem (template): texto pré-aprovado pela Meta. É a única forma de iniciar uma conversa, ou de falar com o cliente depois de 24 horas sem resposta dele.
  • Pacote de links (link pack): os links personalizados da mini-loja (loja, carrinho, checkout) de um cliente.
  • Mini-loja: uma página web leve de compra aberta por um link dentro do WhatsApp, reconhecendo o cliente pelo telefone.
Pontos-chave
  • Todas as rotas são do usuário seller (/api/v1/vendor/whatsapp/...), com o módulo whatsapp-commerce ligado.
  • O catálogo da Meta é do seller: só os produtos dele são enviados, para o catálogo dele. Já a aparência da mini-loja é da loja inteira: um seller que a altera muda para todos.
  • Enviar mensagem pela mini-loja fora da janela de 24 horas exige um modelo aprovado. Sem ele a chamada falha.
  • Muitas respostas e mensagens de erro saem em português, como o servidor devolve.

Como funciona

Do produto ao cliente

Produto no catálogo→Ligar sincronização→Envio à Meta→Produto no WhatsApp
  1. Informar o catálogo

    POST /catalog-sync/enable valida na Meta o id do catálogo e liga a sincronização.

  2. Enviar os produtos

    POST /catalog-sync/full envia os produtos visíveis, em lotes de até 200 por chamada. Um processo automático também atualiza de hora em hora.

  3. Acompanhar

    GET /catalog-sync/products mostra, produto a produto, se o envio deu certo e o motivo de uma falha.

Janela de 24 horas e modelos

Dentro de 24 horas depois da última mensagem do cliente, o seller envia o que quiser. Depois disso, só um modelo aprovado. A rota Enviar a mini-loja escolhe sozinha o melhor caminho: botão com link dentro da janela, modelo fora dela.

Endpoints

Auth: Seller é um usuário do painel do seller (Authorization: Bearer $TOKEN).

MétodoRotaO que fazAuthPágina
GET/api/v1/vendor/whatsapp/settingsLê os ajustes de horário do sellerSellerAjustes do canal
PUT/api/v1/vendor/whatsapp/settingsGrava os ajustes de horárioSellerAjustes do canal
GET/api/v1/vendor/whatsapp/catalog-syncSituação da sincronizaçãoSellerCatálogo na Meta
POST/api/v1/vendor/whatsapp/catalog-sync/enableInforma o catálogo e ligaSellerCatálogo na Meta
POST/api/v1/vendor/whatsapp/catalog-sync/disableDesligaSellerCatálogo na Meta
POST/api/v1/vendor/whatsapp/catalog-sync/fullEnvia os produtos agoraSellerCatálogo na Meta
GET/api/v1/vendor/whatsapp/catalog-sync/productsLista o envio produto a produtoSellerCatálogo na Meta
POST/api/v1/vendor/whatsapp/catalog-sync/products/{id}/retryReenvia um produtoSellerCatálogo na Meta
GET/api/v1/vendor/whatsapp/templatesLista os modelos da conta na MetaSellerModelos e links
GET/api/v1/vendor/whatsapp/templates/modelsSugestões de modelos para criarSellerModelos e links
GET/api/v1/vendor/whatsapp/templates/managedLista os modelos gerenciadosSellerModelos e links
PUT/api/v1/vendor/whatsapp/templates/managed/{id}Ajusta um modelo gerenciadoSellerModelos e links
GET/api/v1/vendor/whatsapp/link-packLinks personalizados da mini-lojaSellerModelos e links
GET/api/v1/vendor/whatsapp/web-preview/settingsLê a aparência da mini-lojaSellerMini-loja
PUT/api/v1/vendor/whatsapp/web-preview/settingsGrava a aparênciaSellerMini-loja
POST/api/v1/vendor/whatsapp/web-preview/mediaEnvia uma imagem para a mini-lojaSellerMini-loja
POST/api/v1/vendor/whatsapp/web-preview/sendEnvia a mini-loja a um telefoneSellerMini-loja

Erros comuns

  • Ligar o catálogo sem número próprio. catalog-sync/enable exige a credencial do número do seller com token. Sem ela: 400.
  • Achar que full envia tudo. Cada chamada processa no máximo 200 produtos. Repita até pushed e failed ficarem em zero.
  • Confundir pushed com "produtos novos". O número também conta produtos retirados da Meta porque saíram do catálogo visível.
  • Mudar horário esperando efeito imediato. Os valores do seller são guardados e devolvidos, mas hoje o atendimento automático não os consulta.
  • Mexer na aparência da mini-loja como se fosse só sua. A configuração é única para a loja.
  • Mandar a mini-loja a um cliente fora da janela sem modelo. A resposta é 502 com o motivo.
  • Esquecer o consentimento do cliente. Mensagens iniciadas pela loja exigem que o cliente tenha aceitado receber. Isso é responsabilidade do seller, não da API.

Próximos passos

Catálogo na Meta
Publicar os produtos no WhatsApp.
Modelos e links
Falar primeiro com o cliente.
Mini-loja
Aparência e envio.
Anterior
Dicionário de marcas
Próxima
Ajustes do canal
Nesta página
  • Como funciona
  • Do produto ao cliente
  • Janela de 24 horas e modelos
  • Endpoints
  • Erros comuns
  • Próximos passos