luanet/magento2-push

Fork Intelipost Push

Manual de Uso: Módulo Push Intelipost

, _(*1)

Introdução

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., _(*2)

Este manual foi divido em quatro partes:, _(*3)

• 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.

Instalação

É recomendado que você tenha um ambiente de testes para validar alterações e atualizações antes de atualizar sua loja em produção., _(*4)

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., _(*5)

Navegue até o diretório raíz da sua instalação do Magento 2 e execute os seguintes comandos:, _(*6)

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

Configurações

Para acessar o menu de configurações, basta seguir os seguintes passos:, _(*7)

No menu à esquerda, acessar Lojas -> Configuration:, _(*8)

, _(*9)

A partir do menu de configurações, clicar no tópico Intelipost -> Push:, _(*10)

, _(*11)

As configurações do módulo foram dividas em três etapas:, _(*12)

• Atributos
• Status dos pedidos
• Cron Config

A seguir vamos falar tudo que você precisa saber de cada uma delas., _(*13)

Atributos

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., _(*14)

Federal tax payer id:

Neste atributo deve ser selecionado qual a propriedade utilizada para o CPF., _(*15)

, _(*16)

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., _(*17)

Status dos pedidos

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., _(*18)

Magento trigger status to create:

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., _(*19)

, _(*20)

No exemplo, está selecionado “Processing”, que é o status do Magento logo após o faturamento do pedido., _(*21)

Magento status after create:

Nessa configuração deve ser selecionado o Status Magento que o pedido deverá receber após o envio para a Intelipost., _(*22)

, _(*23)

No exemplo, está selecionado o status “Criado na Intelipost”, que é um status customizado por mim no nosso ambiente Magento., _(*24)

Create and Ship:

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., _(*25)

, _(*26)

No exemplo, está selecionado “Complete”, que é o Status Magento logo após a criação das entregas no Magento., _(*27)

Cron Config

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., _(*28)

Use cron to create orders:

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., _(*29)

, _(*30)

Use cron to ship orders:

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., _(*31)

Uso

Com a instalação do módulo, será disponibilizado uma nova tabela de pedidos. Essa tabela pode ser consultada no menu Intelipost -> Pedidos:, _(*32)

, _(*33)

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., _(*34)

, _(*35)

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:, _(*36)

, _(*37)

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., _(*38)

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)., _(*39)

, _(*40)

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., _(*41)

Obs: Vale ressaltar que toda tentativa de criação ou despacho, seja de forma manual ou automática, salvará uma Intelipost Message., _(*42)

, _(*43)

Nota Fiscal

O módulo contempla uma tabela de Notas Fiscais (intelipost_invoice). Os campos desta tabela são:, _(*44)

Para consultar e inserir dados nessa tabela via API, você pode utilizar as seguintes métodos:, _(*45)

GET - http://{{url_da_loja}}/rest/v1/push/list
Retornará uma lista com todas as notas salvas até o momento., _(*46)

POST - http://{{url_da_loja}}/rest/v1/push/save
Adicionará a nota fiscal à tabela., _(*47)

Request_body:, _(*48)

{
    "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., _(*49)