WooCommerce integration
Complete manual for the ViaDireta plugin for WooCommerce stores (in Portuguese).
Plugin ViaDireta para WooCommerce · versão 1.1.3
WordPress 6.7 ou superior · WooCommerce 10.0 a 11.2 · PHP 7.4 a 8.5 · 0,4 MB
Visão geral
O plugin liga a sua loja WooCommerce à ViaDireta. Cria as expedições a partir das encomendas, imprime etiquetas e guias de transporte, pede recolhas ao armazém e mostra o seguimento de cada envio, sem copiar dados à mão.
- Envio das encomendas para a ViaDireta, uma a uma, em lote ou automaticamente quando a encomenda muda para um estado escolhido.
- Etiquetas e guias de transporte em PDF, de uma encomenda ou de várias de uma só vez.
- Vários locais de recolha: cada produto sai do armazém ou da loja certa e, se for preciso, a encomenda é dividida num serviço por local.
- Pedido de recolha e manifesto de carga para os volumes à espera de serem recolhidos.
- Recolhas e trocas de artigos devolvidos, pedidas a partir da encomenda e associadas à entrega original.
- Estados de encomenda ViaDireta (Enviada, Em distribuição, Insucesso na entrega, Devolvida…), atualizados pelo seguimento, com email ao cliente.
- Método de envio ViaDireta no checkout (clássico e em blocos), com preço fixo ou por peso e zona, e seguimento na conta do cliente.
Download e instalação
Antes de começar precisa do utilizador e password da API ViaDireta. Se ainda não os tem, peça-os ao seu gestor ViaDireta ou através dos contactos.
- Descarregue o ficheiro
viadireta-woocommerce-v1.1.3.zip(botão acima). - No WordPress, abra Plugins › Adicionar plugin › Carregar plugin, escolha o ficheiro e carregue em Instalar agora; depois em Ativar.
- Abra WooCommerce › Configurações › ViaDireta e siga a configuração.
Atualizar para uma versão nova
Carregue o ficheiro da versão nova em Plugins › Adicionar plugin › Carregar plugin e escolha Substituir a atual pela carregada. A configuração e as expedições mantêm-se.
Desinstalar
Em Plugins, desative e elimine o plugin. A configuração é sempre apagada; as expedições, os pedidos de recolha e as devoluções só são apagados se em Ao desinstalar (secção API) escolher “Apagar também”. Antes de desinstalar, mude as encomendas que estejam num estado ViaDireta (por exemplo Enviada ou Em distribuição) para um estado do WooCommerce: sem o plugin esses estados deixam de existir.
Configuração
A configuração está em WooCommerce › Configurações › ViaDireta e tem quatro secções. Guarde cada uma com Guardar alterações.
1. API: ligação e modo
- Preencha o Utilizador API e a Password API e carregue em Associar / testar ligação. O plugin confirma as credenciais, lê as contas a que dão acesso e traz os locais de recolha.
- Escolha o Modo: Testes usa a conta de testes da ViaDireta, para experimentar sem criar envios reais; Produção usa a sua conta.
- Confirme que o Estado está Ativo e guarde.
2. Expedição: contas, locais de recolha e valores por omissão
- Contas ViaDireta: conta usada nas entregas e, se tiver, contas próprias para recolhas e para trocas. Com uma só conta, fica escolhida logo ao associar.
- Locais de recolha: os armazéns e lojas da sua conta, trazidos com Sincronizar com a ViaDireta. Escolha o local por omissão (ou a Morada da conta (predefinida)). Para ter mais locais de recolha, peça ao suporte ViaDireta: dsii@viadirectanet.pt.
- Encomendas com artigos de vários locais: dividir num serviço por local ou enviar tudo do mesmo local. Numa encomenda dividida, a cobrança vai toda no primeiro serviço.
- Valores por omissão das expedições: documento a imprimir (etiqueta ou guia de transporte), data do serviço em dias úteis (nunca para o próprio dia, fins de semana ou feriados nacionais) e peso por omissão.
3. Automação: envio automático, estados e avisos
- Estados prontos para envio e Enviar automaticamente (desligado numa instalação nova): a expedição é criada sozinha quando a encomenda passa para um desses estados. Pode limitar às encomendas com o método de envio ViaDireta.
- Estado da encomenda após envio (por omissão Enviada) e Notificar o cliente por email com o número e o link de seguimento.
- Estados mostrados na lista de expedições.
- Estados de encomenda ViaDireta: ligue ou desligue cada estado próprio do plugin e escolha o estado da encomenda em cada fase do seguimento (em distribuição, insucesso, entregue, devolvido).
- Devoluções: estado da encomenda ao registar uma recolha ou troca e quando é concluída.
- Atualizações da ViaDireta (webhook) e seguimento para o cliente (na conta e nos emails).
4. Checkout: o método de envio ViaDireta
- Preço dos portes: preço fixo ou por peso e zona, com escalões “até X kg → preço” para Portugal Continental, Açores e Madeira (pelo código postal) e restantes países, com tabelas país a país se quiser.
- Portes grátis a partir de um valor e Peso máximo.
- Para o comprador ver a opção, adicione o método ViaDireta às zonas de envio em WooCommerce › Configurações › Envio. O nome no checkout e o imposto configuram-se em cada zona.
Local de recolha do produto
Ao editar um produto, no separador Envio dos dados do produto, a lista Local de recolha (ViaDireta) escolhe de onde sai: um dos locais sincronizados ou a Morada da conta (predefinida). As variações herdam o local do produto. Sem escolha, sai do local por omissão.
Expedições ViaDireta
Em WooCommerce › ViaDireta (com o número de encomendas por enviar no menu) tem as encomendas com os produtos (e o local de cada um), o destino, o envio e pagamento, o estado e os envios ViaDireta de cada uma. As vistas Todos / Por enviar / Enviadas / Com erro, a pesquisa e o filtro de estado ajudam a encontrar o que procura. Em modo de testes aparece sempre um aviso no topo.
Botões do topo
- Enviar pendentes: envia de uma vez as encomendas nos estados prontos para envio que ainda não têm expedição. Com encomendas selecionadas, passa a Enviar selecionadas.
- Imprimir etiquetas (ou guias, no ▾): junta num único PDF os documentos das encomendas selecionadas.
- Pedir recolha: ver Pedido de recolha.
- Atualizar estados: consulta o seguimento de todos os envios ainda não concluídos.
Enviar uma encomenda
O botão Enviar da linha abre o formulário com os dados já preenchidos (nome, morada, contacto, email, data do serviço, volumes, peso, cobrança, local de recolha, descrição e observações). Pode corrigir o que for preciso antes de enviar. A cobrança é preenchida sozinha quando o pagamento é Pagamento na entrega.
Menu ▾ de cada encomenda
Cada serviço ViaDireta da encomenda (entregas e recolhas / trocas) tem um submenu com Etiqueta, Guia de transporte, Seguimento e Pedir recolha / troca. Em baixo:
- Enviar para ViaDireta (de novo): cria uma nova expedição para a mesma encomenda.
- Anular envio (só na loja): apaga o registo na loja, retira as notas da encomenda escritas pelo plugin e repõe o estado anterior, para poder enviar outra vez. Não anula o serviço na ViaDireta.
Estado e histórico
Cada serviço mostra o nº de seguimento, o local de recolha e a fase. O botão ⟳ atualiza o estado; o botão ☰ (Histórico) mostra os movimentos de todos os serviços da encomenda, lado a lado.
Pedido de recolha e manifesto de carga
O botão Pedir recolha pede à ViaDireta que venha buscar os volumes. Mostra os serviços à espera de recolha agrupados por local, com volumes e peso. Escolha a data, a hora a partir da qual pode ser feita a recolha, o contacto e eventuais observações, e carregue em Enviar pedido. É registado um pedido por local na ViaDireta e o armazém recebe o aviso por email.
Manifesto de carga
No ▾ ao lado de Pedir recolha: Imprimir manifesto de carga (um PDF por local, com os serviços à espera de recolha das encomendas selecionadas ou de todas, totais e assinaturas) e a escolha do local de recolha das encomendas selecionadas.
WooCommerce › Encomendas
Na lista de encomendas aparece a coluna Expedição ViaDireta com os números de seguimento e a fase: entregas a verde, recolhas e trocas a azul, encomendas por enviar a cinzento.
O botão ViaDireta ▾ ao lado de Adicionar encomenda envia as selecionadas ou as pendentes e imprime etiquetas ou guias das selecionadas. Em cada linha, o botão ViaDireta ▾ tem o mesmo menu da lista de expedições, mais o Histórico.
Editar encomenda
Na página da encomenda, a caixa ViaDireta (à direita) mostra os números de seguimento e a fase de cada serviço, o botão Enviar para ViaDireta (antes do envio) ou o do documento configurado, ⟳ e o menu ▾. Depois do envio, a encomenda fica com uma nota com o número e o link de seguimento; com Notificar o cliente, a nota segue por email.
Devoluções: recolhas e trocas
O WooCommerce não tem um módulo de devoluções, por isso a devolução nasce na encomenda: Pedir recolha / troca (na caixa ViaDireta e nos menus ▾ da encomenda e de cada entrega) abre um formulário onde escolhe:
- o serviço: Recolha no cliente (R) ou Troca: entregar novo e recolher (ER);
- os artigos e as quantidades a devolver (por omissão, as quantidades já reembolsadas) e o motivo;
- a entrega original, o local de recolha de destino e os dados do cliente.
- O número de serviço é o da entrega original com
R(recolha) ouTR(troca) no fim. Se repetir, ficaR2,TR2… - Os serviços aparecem a azul nas listas e no histórico. Quando concluídos, a fase passa a Recolhido ou Troca efetuada.
Checkout e área de cliente
Com o método ViaDireta numa zona de envio, o comprador vê a opção Entrega ViaDireta com o preço dos portes calculado pelas tarifas configuradas (no checkout clássico e no checkout em blocos).
Em A minha conta › Encomendas › Ver, o cliente vê o número de seguimento, o último estado e o botão Seguir envio. O número e o link também vão nos emails da encomenda.
Estados, emails e webhook
O plugin acrescenta estados de encomenda próprios, que funcionam como os do WooCommerce (vistas, filtros, ações em massa e relatórios): Enviada, Em distribuição, Insucesso na entrega, Devolvida, Recolha pedida, Troca pedida, Recolhida e Troca efetuada. A encomenda entregue passa a Concluída. Cada estado pode ser desligado na secção Automação e tem um email ao cliente em WooCommerce › Configurações › Emails.
| Fase | Quando |
|---|---|
| Em preparação | Registado, atribuído a uma zona, agendado ou no armazém ViaDireta. |
| Em distribuição | Saiu com o estafeta. |
| Entregue / Recolhido / Troca efetuada | Concluído com sucesso. |
| Insucesso | Tentativa sem sucesso; continua a ser seguido. |
| Devolvido | Devolvido ao remetente. |
O estado da encomenda só avança e, numa encomenda dividida, conta o serviço mais atrasado. Os estados atualizam-se pelo botão Atualizar estados, pelo ⟳ de cada encomenda ou, na hora, pelos avisos da ViaDireta (webhook): copie o Endereço e o Segredo da secção Automação e envie-os ao seu gestor ViaDireta.
Detalhes técnicos do webhook
A ViaDireta envia POST {loja}/wp-json/viadireta/v1/webhook em JSON, com os cabeçalhos X-ViaDireta-Timestamp (segundos Unix, aceite até 5 minutos de diferença) e X-ViaDireta-Signature: sha256=<HMAC-SHA256(segredo, timestamp + "." + corpo)>. A loja só aceita avisos das contas configuradas e ignora serviços que não são seus.
Dúvidas frequentes
O botão “Associar / testar ligação” dá erro.
Confirme o utilizador e a password da API (são diferentes dos da área de cliente) e se o servidor da loja tem acesso à Internet por HTTPS. Se o erro continuar, ative o Registo de depuração na secção API e envie o registo de WooCommerce › Estado › Registos (origem viadireta) ao suporte ViaDireta.
A opção ViaDireta não aparece no checkout.
Confirme que o método ViaDireta está adicionado à zona de envio do cliente (WooCommerce › Configurações › Envio), que a zona / país tem preço nas tarifas e que o carrinho não passa do Peso máximo.
Os produtos saem de armazéns diferentes. Como faço?
Sincronize os locais de recolha (secção Expedição) e escolha o local em cada produto (Envio › Local de recolha (ViaDireta)). Com a divisão ligada, a encomenda é dividida num serviço por local, com uma etiqueta para cada um.
Enviei encomendas em modo de testes. Tenho de as anular?
Não. As expedições de testes ficam marcadas TESTE e, em produção, a encomenda pode ser enviada normalmente.
Anulei um envio na loja. Foi anulado na ViaDireta?
Não. “Anular envio (só na loja)” apaga apenas o registo na loja. Para anular o serviço na ViaDireta, contacte o apoio ao cliente.
Precisa de ajuda? Fale connosco.