O módulo Push Intelipost é responsável por enviar as entregas criadas no Magento para a Intelipost. Este processo é indispensável para o uso do Rastreamento e Gestão de Despacho da nossa ferramenta.
Este manual foi divido em quatro partes:
- Instalação: Onde você econtrará instruções para instalar nosso módulo.
- Configurações: Onde você encontrará o caminho para realizar as configurações e explicações de cada uma delas.
- Uso: Onde você encontrará a maneira de utilização de cada uma das funcionalidades.
- Nota Fiscal: Seção dedicada a descrever a tabela de Notas Fiscais criada pelo módulo e também como alimentá-la por API.
É recomendado que você tenha um ambiente de testes para validar alterações e atualizações antes de atualizar sua loja em produção.
A instalação do módulo é feita utilizando o Composer. Para baixar e instalar o Composer no seu ambiente acesse https://getcomposer.org/download/ e caso tenha dúvidas de como utilizá-lo consulte a documentação oficial do Composer.
Navegue até o diretório raíz da sua instalação do Magento 2 e execute os seguintes comandos:
bin/composer require intelipost/magento2-push // Faz a requisição do módulo da Intelipost
bin/magento module:enable Intelipost_Push // Ativa o módulo
bin/magento setup:upgrade // Registra a extensão
bin/magento setup:di:compile // Recompila o projeto Magento
Para acessar o menu de configurações, basta seguir os seguintes passos:
No menu à esquerda, acessar Lojas -> Configuration:
A partir do menu de configurações, clicar no tópico Intelipost -> Push:
As configurações do módulo foram dividas em três etapas:
- Atributos
- Status dos pedidos
- Cron Config
A seguir vamos falar tudo que você precisa saber de cada uma delas.
Nesta seção, abrimos espaço para o cliente definir os parâmetros que ele criou para informações que não existem no Magento por padrão.
Neste atributo deve ser selecionado qual a propriedade utilizada para o CPF.
Note que o campo escolhido no exemplo não é o correto. Você deve conversar com o representante da loja e descobrir em qual propriedade é registrado o CPF do cliente final.
Nesta seção, deverá realizado as configurações de movimentação dos pedidos. Isto é, quando o pedido deve ser enviado para a Intelipost ou quando deve ser despachado.
Nessa configuração deve ser selecionado o Status Magento do pedido em que ele deve ser criado na Intelipost. Nesta lista, aparecerão todos os status disponíveis, até mesmo os status customizados.
No exemplo, está selecionado “Processing”, que é o status do Magento logo após o faturamento do pedido.
Nessa configuração deve ser selecionado o Status Magento que o pedido deverá receber após o envio para a Intelipost.
No exemplo, está selecionado o status “Criado na Intelipost”, que é um status customizado por mim no nosso ambiente Magento.
Se esta configuração estiver marcada como "Sim", quando o pedido for enviado para a Intelipost, ele receberá a data de despacho igual ao momento do envio. Agora, se esta configuração for marcada como “Não”, será disponibilizada uma nova configuração: Magento trigger status to ship. Semelhante à “Magento trigger status to create”, você deve selecionar o Status Magento em que o pedido deverá ser marcado como despachado na Intelipost.
No exemplo, está selecionado “Complete”, que é o Status Magento logo após a criação das entregas no Magento.
Nesta seção faremos as configurações dos eventos cronológicos do módulo. Isto é, decidiremos em quais condições os pedidos serão enviados automaticamente para a Intelipost.
Habilita o envio das entregas para a Intelipost a partir de um processo agendável. Caso essa configuração for marcada como "Sim", será disponibilizado outras três configurações:
- Cron status to create: Deverá ser configurado o Status Magento em que o pedido será enviado para Intelipost.
- Order quantity to create: Deverá ser estipulado a quantidade de pedidos necessária para envio para a Intelipost.
- Frequency to create: Deverá ser selecionado o intervalo de tempo, em minutos, que o processo será executado.
Muito semelhante à configuração anterior, essa configuração habilita o despacho dos pedidos a partir de um processo agendável. aso essa configuração for marcada como "Sim", será disponibilizado outras três configurações:
- Cron status to ship: Deverá ser configurado o Status Magento em que o pedido será marcado como despachado na Intelipost.
- Order quantity to ship: Deverá ser estipulado a quantidade de pedidos necessária para realizar o despacho na Intelipost.
- Frequency to ship: Deverá ser selecionado o intervalo de tempo, em minutos, que o processo será executado.
Com a instalação do módulo, será disponibilizado uma nova tabela de pedidos. Essa tabela pode ser consultada no menu Intelipost -> Pedidos:
A nova tela de pedidos apresentará todos os dados de envio gerados a partir de uma cotação da Intelipost. Também apresentará o Status Magento e o Status Intelipost de cada um deles.
Caso o cliente utilize a gestão de despacho com a Intelipost, ele poderá consultar os códigos de rastreamento direto do Magento. Para habilitar essa coluna na tabela, basta clicar em Columns -> Tracking Code:
O módulo Push também permite ao cliente operar de forma manual, isto é, enviar ou despachar os pedidos a partir de comandos do Magento. Esses comandos estão disponíveis também em lote.
Para realizar uma dessas ações, você deve selecionar os pedidos desejados e, em Actions, selecionar Create Orders (para criar as entregas) ou Ship Orders (para despachar as entregas).
Após ter realizado a ação, uma mensagem de erro ou sucesso aparecerá no topo da página. Além disso, ela ficará salva na coluna Intelipost Message.
Obs: Vale ressaltar que toda tentativa de criação ou despacho, seja de forma manual ou automática, salvará uma Intelipost Message.
O módulo contempla uma tabela de Notas Fiscais (intelipost_invoice). Os campos desta tabela são:
| Campo | Descrição | Tipo |
|---|---|---|
| id | Identificador primário | integer (auto increment) |
| invoice_number | Número da nota fiscal | varchar |
| order_number | Número do pedido que a nota está relacionada | varchar |
| invoice_series | Série da nota fiscal | varchar |
| invoice_key | Chave da nota fiscal | varchar |
| invoice_date | Data de criação da Nota Fiscal | current_timestamp |
| invoice_total_value | Valor total da nota fiscal | varchar |
| invoice_products_value | Valor dos produtos | varchar |
| invoice_cfop | CFOP dos produtos da nota | varchar |
Para consultar e inserir dados nessa tabela via API, você pode utilizar as seguintes métodos:
GET - http://{{url_da_loja}}/rest/V1/push/list
Retornará uma lista com todas as notas salvas até o momento.
POST - http://{{url_da_loja}}/rest/V1/push/save
Adicionará a nota fiscal à tabela.
Request_body:
{
"invoice": [
{
"invoice_number": "10",
"order_number": "000000006",
"invoice_series": "1",
"invoice_key": "01234567890123456789012345678901234567891234",
"invoice_date": "2017-11-28 19:47:35",
"invoice_total_value": "10.20",
"invoice_products_value": "10.00",
"invoice_cfop": "1612"
}
]
}Obs: Para realização das chamadas, deverá ser passado o token de autenticação do usuário. Para mais detalhes, consulte a documentação do Magento.