API atual/Referência completa/Mini-loja WhatsApp: atendimento

Central de ajuda da loja

Lê a central de ajuda da mini-loja, com perguntas frequentes, contatos, páginas institucionais e o que o atendimento oferece agora.

A tela "Ajuda" da mini-loja tem uma só leitura: esta rota. Ela devolve as perguntas frequentes (FAQ), os contatos e as páginas institucionais da loja, e diz quais canais de atendimento estão abertos neste momento: reclamação, qualificação de revendedor e conversa com uma pessoa.

Ler a central de ajuda

GET/api/v1/storefront/wa-coex/support/{token}Pública

Perguntas frequentes, contatos e canais de atendimento da loja

Funciona para visitante e para cliente identificado. O que a loja não configurou ganha um padrão: o FAQ ganha respostas genéricas sobre pagamento e frete, o recado de resposta ganha um texto padrão e a reclamação vem ligada.

Parâmetros de caminho

tokenstringobrigatório

Token da mini-loja.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/wa-coex/support/$TOKEN"

Resposta

200Central de ajuda

json

{
  "faq": [
    {
      "id": "pagamento",
      "title": "Formas de pagamento",
      "answer": "As formas disponíveis para seu cadastro e para o total do pedido aparecem no checkout, antes da confirmação.",
      "source": "runtime_policy"
    },
    {
      "id": "entrega",
      "title": "Frete e prazo",
      "answer": "O frete e o prazo são calculados com o endereço e os itens da sacola. O valor mostrado na revisão é o usado no pedido.",
      "source": "runtime_policy"
    }
  ],
  "reseller_enabled": false,
  "complaint_enabled": true,
  "human_enabled": true,
  "human_available": true,
  "contact_url": "https://wa.me/5511999998888",
  "response_message": "Recebemos sua solicitação. Nossa equipe vai analisar e continuar o atendimento.",
  "store_info": {
    "contacts": [
      { "kind": "phone", "label": "(11) 9999-9999", "url": "tel:+5511999999999" },
      { "kind": "email", "label": "contato@minhaloja.com.br", "url": "mailto:contato@minhaloja.com.br" }
    ],
    "pages": [
      { "slug": "faq", "title": "Central de Ajuda", "url": "/faq", "text": "Como faço um pedido na loja? ..." }
    ]
  }
}

Campos da resposta

faqarray

Perguntas e respostas: id, title, answer e source (tenant_config quando vem da configuração da loja, runtime_policy quando é o texto padrão). Até 20 itens. Sem FAQ configurado, vêm as respostas padrão de pagamento e entrega, mais pedido mínimo (se houver) e, em loja B2B, cadastro de revendedor.

reseller_enabledboolean

A loja faz qualificação de revendedor (reseller-leads). Por padrão, só em lojas B2B.

complaint_enabledboolean

A loja aceita reclamações pela mini-loja (complaints). Por padrão, sim.

human_enabledboolean

A loja tem atendimento humano configurado (a funcionalidade está ligada, o plano inclui e o chat com vendedor é permitido).

human_availableboolean

Há alguém para atender agora, dentro do horário. human_enabled sozinho é configuração, não relógio.

human_unavailable_messagestring

Frase para mostrar quando não dá para falar com uma pessoa (atendimento desligado ou fora do horário).

next_openstring

Quando o atendimento volta (por exemplo "amanhã às 08:00"). Vazio se há alguém disponível ou se não se sabe.

contact_urlstring

Link wa.me para abrir o WhatsApp da loja. Ausente se a loja não tem número válido.

response_messagestring

Texto que a tela mostra depois de o cliente enviar uma solicitação.

store_infoobject

Contatos, redes sociais e páginas institucionais do painel (os mesmos do rodapé do site). Omitido quando a loja não tem nada disso.

contactsarray

Contatos: kind, label, url.

socialsarray

Redes sociais: kind, label, url.

pagesarray

Páginas institucionais em texto simples (sem HTML), até 6.000 caracteres cada: slug, title, url, text.

policy_pagesarray

Páginas de regras, termos e privacidade que o checkout linka. Abrem num diálogo e não entram na lista do rodapé.

Erros

Esta rota só tem os erros comuns de token, descritos em Mini-loja do WhatsApp.

Veja também