Canada Post Universal Shipping para Magento® 2.x

Canada Post Universal Shipping é uma extensão para Magento 2 que permite gerenciar todo o ciclo de envio pela Canada Post por meio da API da Canada Post.

A Canada Post é o serviço postal nacional do Canadá: entrega em todos os endereços do país e em mais de 190 destinos no mundo. A extensão conecta sua loja a essa rede de ponta a ponta — tarifas em tempo real no checkout, etiquetas e documentos aduaneiros pelo admin, rastreamento, cancelamentos, devoluções, coletas e manifestos de fim de dia.

As principais vantagens da extensão Canada Post Universal Shipping são:

Etiquetas de envio em PDF e térmicas

A criação de etiquetas de envio é possível manualmente, em massa a partir da grade de pedidos, automaticamente e até de forma agendada. A extensão associa cada etiqueta a um pedido, a um envio ou a uma nota de crédito. Todas as etiquetas ficam no seu servidor e continuam acessíveis a qualquer momento pela interface administrativa.
Antes de criar uma etiqueta manualmente, você escolhe o serviço da Canada Post desejado e vê de imediato o custo do envio. No modo automático, as etiquetas são criadas conforme o método escolhido pelo comprador ou conforme um serviço nacional e internacional que você configura. As etiquetas voltam em PDF nos formatos 8.5x11, 4x6 e 3x5, ou em ZPL para impressoras térmicas.

Tarifas e métodos de envio

Obtenha tarifas de envio no checkout exatamente como em canadapost.ca. Os preços de envio dependem dos códigos postais de origem e destino, do peso, das dimensões, do tipo de endereço e das opções ativas — tudo isso é considerado pela extensão. As cotações ficam em cache por um intervalo definido por você, de modo que um checkout movimentado não volte a consultar a transportadora pelo mesmo carrinho. O custo de um método pode ser estático ou dinâmico, preços e exibição se ajustam por limites e você cria quantos métodos quiser. Leia mais aqui.

Contas com e sem contrato

Um número de contrato comercial libera tarifas negociadas, cobrança em conta, manifestos e Open Returns. Sem contrato você ainda cota e envia: a extensão passa a usar o endpoint sem contrato e cada etiqueta é liquidada por envio. O frete é pago somente à Canada Post — a extensão não cobra pelo envio, pelas etiquetas nem pelas consultas de tarifa.

Devoluções

Dois fluxos de devolução, ambos nativos da Canada Post. Um Authorized Return emite uma etiqueta por volume, com o seu endereço como destinatário. Um Open Return é um modelo permanente do qual a loja extrai etiquetas até esgotar a cota — crie-o com um botão nas configurações de devolução e a extensão guarda o ID do modelo para você. Os clientes podem solicitar uma etiqueta de devolução na área do cliente, e ela chega por e-mail no modelo que você controla.

Coleta e rastreamento

Solicite a coleta de encomendas diretamente pelo painel administrativo da sua loja — sob demanda para uma janela específica ou por uma agenda semanal fixa. A disponibilidade para um código postal pode ser verificada antes da reserva, e uma coleta reservada pode ser cancelada.

Depois que suas encomendas saem, acompanhe-as com nossa extensão. Você vê todos os pontos por onde a encomenda passou e onde ela está, seja em uma janela dentro do Magento, seja no site da Canada Post, e o código de rastreamento viaja no e-mail do pedido.

Manifestos

Lojistas com contrato podem reunir os envios em um grupo e transmiti-los de uma vez no fim do dia, em vez de um a um. Faça o fechamento manualmente pelo admin ou deixe por conta do cron; o PDF do manifesto gerado pela Canada Post é baixado e guardado junto às etiquetas, e o número de PO assinado pelo motorista fica registrado em cada etiqueta do grupo.

Alfândega e envios internacionais

As declarações aduaneiras das etiquetas internacionais são montadas a partir dos produtos faturados do pedido. Motivo da exportação, moeda aduaneira, tributos pré-pagos, números de licença e certificado de exportação, registro IOSS para a União Europeia e a declaração AES para os Estados Unidos são todos configuráveis, e um destinatário «sold to» distinto pode ser enviado quando difere do consignatário.

Localizador de agências

Deixe o comprador escolher a agência onde retirará a encomenda. A busca é feita em torno do código postal de entrega, dentro de um raio definido por você, e mostra os resultados em lista ou em um mapa do Google ou do Bing. A agência escolhida vai para a etiqueta como entrega para retirada.

Impressão

A impressão é uma das etapas mais importantes ao trabalhar com etiquetas de envio. Use nosso aplicativo para imprimir etiquetas em PDF e térmicas em impressoras locais e de rede. Você pode obtê-lo aqui. Cada tipo de documento — etiqueta, romaneio, fatura — pode ser direcionado à sua própria impressora.

Configuração

Os recursos do nosso módulo são praticamente ilimitados graças a configurações flexíveis. Ao mesmo tempo, as configurações são intuitivas e muitas já vêm definidas. Você configura a extensão para uma loja específica ou para um país específico. É possível aplicar certas configurações aos envios nacionais e outras aos internacionais, e também há configurações separadas para etiquetas de devolução.

O que você precisa

Uma conta no Canada Post Developer Program, que emite uma chave de API e a vincula ao seu número de cliente, e um endereço de origem canadense — a Canada Post envia a partir do Canadá.

Demonstração

Você pode testar esta extensão por 30 dias. Solicite a demonstração nesta página com Solicitar demo; como funciona está explicado em Teste uma extensão por 30 dias.

Hyva Theme e Hyva Checkout

Compatível com Hyva Theme e Hyva Checkout

A extensão é instalada com o Composer. Qual repositório você adiciona depende de onde a comprou — a instalação em si é a mesma nos dois casos.

1. Conectar o repositório

Comprada na extmag.com. A página da sua conta mostra o endereço do repositório e as suas credenciais pessoais, junto com os dois comandos composer config para colar. Execute-os uma vez por projeto; depois disso, todas as extensões que você possui ficam disponíveis no mesmo repositório.

Comprada no Adobe Commerce Marketplace. O pacote é servido por repo.magento.com, que a maioria das lojas já tem configurado. Se não for o caso, adicione as Access Keys da sua conta Adobe em My Profile -> Access Keys.

2. Instalar a extensão

Execute na raiz do projeto:

composer require extmag/canadapostshipping
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:flush

O Composer resolve os pacotes compartilhados da Extmag dos quais a extensão depende, então não há mais nada a exigir manualmente.

Saia do admin e entre novamente: a extensão está pronta.

3. Obter suas credenciais da Canada Post

Cadastre-se no Canada Post Developer Program. O cadastro emite uma chave de API — um nome de usuário e uma senha — e a vincula ao seu número de cliente. A Canada Post emite duas chaves distintas, uma para o gateway de desenvolvimento e outra para produção; elas não são intercambiáveis. Mantenha uma conta de remetente para cada uma e alterne entre elas com o interruptor Live Account do formulário da conta.

O número de contrato comercial é opcional: sem ele, a extensão continua cotando e enviando, com tarifas publicadas e liquidação por etiqueta. Cobrança em conta, manifestos e Open Returns exigem contrato.

Requisitos

• Magento 2.4.x (Open Source ou Adobe Commerce)
• PHP 8.1 ou mais recente, Composer 2.x
• Uma chave de API do Canada Post Developer Program e o número de cliente
• Um endereço de origem canadense — a Canada Post envia a partir do Canadá
• Acesso HTTPS de saída para soa-gw.canadapost.ca e ct.soa-gw.canadapost.ca

Cron

A extensão registra uma tarefa horária que fecha os grupos de manifesto quando a estratégia de manifesto está no cron diário. Na estratégia padrão, cada envio é transmitido assim que é criado e a tarefa termina imediatamente. O cron do Magento precisa estar em execução para que a variante agendada feche qualquer coisa.

Impressão de etiquetas

Para imprimir etiquetas em uma impressora local ou de rede, instale o nosso software de impressão aqui e siga depois Instalação e configuração do el-Print.

Hyva Theme e Hyva Checkout

Lojas em Hyva precisam de um pacote a mais:

composer require extmag/shiplab-hyva
composer require magewirephp/magewire

A integração substitui um template do Hyva, view/frontend/templates/checkout/shipping/method-list.phtml. Se o seu tema já sobrescreve esse arquivo, mescle as alterações em vez de substituí-lo.

Testar antes de comprar

Você pode solicitar uma demonstração de 30 dias desta extensão e instalá-la exatamente como acima — mesmo pacote, mesmo repositório, mesmos comandos. Como funcionam as demonstrações.

Instalação sem Composer

O arquivo pode ser descompactado em app/code/Extmag/, mas isso deixa a extensão fora do gerenciamento de dependências: os pacotes compartilhados precisam ser instalados manualmente e as atualizações nunca chegam até ela. Use o Composer em qualquer loja que você opere, inclusive na demonstração.

Em caso de dúvida sobre a instalação, fale com o nosso suporte técnico.

A Canada Post é configurada pelo menu Extmag no admin do Adobe Commerce (Magento). Cadastre a conta da transportadora, o endereço canadense de onde você envia, as caixas em que embala e os métodos de envio que os clientes veem, e depois ajuste a configuração da transportadora.

Conta da Canada Post

1. Se você ainda não tem credenciais de API da Canada Post, cadastre-se no Canada Post Developer Program. O cadastro emite uma chave de API — um nome de usuário e um segredo — e a vincula ao seu número de cliente.
2. Vá em Admin Main Menu -> Extmag -> Shipper Accounts.
   
3. Clique no botão «Add New Shipper Account».
4. Escolha Canada Post como transportadora, informe o nome de usuário da chave de API, o segredo e o seu número de cliente como Shipper Number e clique em «Save». Deixe Live Account em No enquanto estiver testando: a Canada Post emite chaves separadas para o gateway de desenvolvimento e para o de produção, e elas não são intercambiáveis. Mantenha uma conta por chave e alterne entre elas pela configuração.
   

Endereços

1. Vá em Admin Main Menu -> Extmag -> Settings -> Addresses.
2. Clique no botão «Add New Address».
3. Preencha razão social, contato, telefone e o endereço completo e clique em «Save». A origem precisa ser canadense — a Canada Post envia a partir do Canadá — com um código de província de duas letras válido e um código postal no formato A1A1A1. São usados dois endereços por transportadora: o Shipper Address impresso na etiqueta e o Ship From Address onde a encomenda é coletada, que também é o ponto de expedição do manifesto quando os dois diferem.

Package Boxes

1. Vá em Admin Main Menu -> Extmag -> Settings -> Package Boxes.
2. Clique no botão «Add New Box».
3. Informe as dimensões internas e externas, o peso vazio e a carga máxima e clique em «Save». O algoritmo de embalagem distribui o pedido entre volumes a partir dessas caixas: quanto mais caixas reais estiverem cadastradas, mais a tarifa cotada se aproxima da que será cobrada. A Canada Post aceita até 30 kg por volume.

Métodos de envio

1. Vá em Admin Main Menu -> Extmag -> Shipping Methods.
2. Clique no botão «Add New Shipping Method».
3. Escolha Canada Post como transportadora, defina quais serviços exibir — todos, uma lista específica, ou apenas o mais barato ou o mais caro — e restrinja o método por site e por grupo de clientes, se precisar. Clique em «Save». A lista de serviços é filtrada pelo país de origem, de modo que uma origem canadense oferece os grupos nacional, Estados Unidos e internacional.
   

Configuração

1. Vá em Admin Main Menu -> Extmag -> Settings -> Canada Post Configuration.
2. Abra primeiro a aba General e selecione a conta de remetente, o Shipper Address e o Ship From Address criados acima. Informe o número do contrato comercial, se tiver um: sem ele, cotação e envio voltam às tarifas publicadas.
   
3. Percorra as demais abas e preencha o que se aplica à sua conta.

As abas cobrem:

• General — conta, endereços, número do contrato, os números de cliente de Mailed By e Mailed On Behalf Of, tipo de destino e a descrição do envio.
• Packaging — as unidades de peso e dimensão. A Canada Post codifica a embalagem no código do serviço e calcula o peso cubado por conta própria.
• Returns — Authorized Returns ou Open Returns, o serviço de devolução, o botão que cria um modelo Open Return, a cota de etiquetas e o que o cliente pode fazer na área dele.
• References — o centro de custo e as duas referências de cliente gravadas em um envio com contrato.
• Payments — moeda, quem paga o transporte e quem paga os tributos, a forma de pagamento, o valor segurado, o pagamento contra entrega e a chave de conta Zonos exigida para destinos nos Estados Unidos.
• Notification — os eventos que a Canada Post notifica por e-mail, o idioma deles e os destinatários.
• Printing — tamanho do papel (8.5x11, 4x6, 3x5), codificação PDF ou ZPL e o que é impresso na etiqueta.
• Pickups — como a coleta é cobrada, onde o motorista deve ir, os indicadores de caminhão e doca, e a agenda semanal que o cron segue.
• Tracking — se o rastreamento abre em uma janela dentro do Magento ou como link para o site da Canada Post.
• Post Office Locator — a retirada em agência no checkout, o raio de busca, a exibição em lista ou mapa e a chave do Google ou do Bing.
• International Invoice — o bloco aduaneiro: moeda, motivo da exportação, tributos pré-pagos, números de licença e certificado, registro IOSS, o identificador de declaração para os Estados Unidos e o destinatário «sold to».
• Manifest / Closeout — transmitir cada envio assim que é criado, fechar manualmente ou deixar para o cron diário, além do endereço impresso no manifesto.
• Automatic, Mass Actions e Manual Actions — quando as etiquetas são criadas sem operador, em massa a partir da grade de pedidos, ou uma a uma.
• Other Options — envios sem contrato, tipo de cotação, por quanto tempo uma tarifa fica em cache, o código de rastreamento no e-mail do pedido, o tratamento de encomendas não entregues e as opções de entrega padrão.

Cada configuração pode ser aplicada por site, por direção e por país de destino, de modo que uma regra que só faz sentido para um mercado não afete os demais.

Devoluções

A aba Returns decide qual dos dois fluxos de devolução da Canada Post a loja usa. Um Authorized Return emite uma etiqueta por volume. Um Open Return é um modelo permanente: clique em «Create Template» e a extensão o registra na Canada Post, guarda o ID do modelo e extrai etiquetas dele até esgotar a cota. A mesma aba controla se o cliente pode solicitar ou reimprimir uma etiqueta de devolução na área dele e qual modelo de e-mail a transporta.

Etiquetas de envio

Depois que a transportadora está configurada, cada etiqueta criada pela loja aparece em Admin Main Menu -> Extmag -> Shipping Labels -> Canada Post, com o código de rastreamento, o custo, o estado do manifesto e os documentos anexados. As etiquetas são criadas na tela do pedido, em massa a partir da grade de pedidos ou automaticamente — quem decide isso são as abas Automatic, Mass Actions e Manual Actions.