Integração de interfaces para transferência de dados de Estoque e Vendas de Veículos entre BYD e concessionárias.

Este projeto trata da integração de 8 interfaces para transferência de dados de Veículos entre BYD e concessionárias.

Este procedimento refere-se a concessionárias da marca BYD.

Neste documento são descritos os procedimentos para a integração de APIs da BYD com as concessionárias.

1.Parametrizações Auxiliares 

1.1 Manutenção de Situação de Veículos:

Veículos  >  Cadastros > Tipo de Situação 

Necessário fazer a associação entre a situação do LinxDMS  e a situação que será usada para envio dos veículos pela API. As situações possíveis são :  
 

2.Parâmetros BYD =>  Fábrica > BYD > Parâmetros 

2.1. Preencher as Informações da Concessionária BYD e marcar o campo 'Habilita Integração API BYD' para ativar as integrações:

        Org Code: Informação disponibilizada pela BYD.
        Dealer Code: Informação disponibilizada pela BYD. Utilizada para integrações de Pos-Vendas.
        Org Name: Informações serão carregadas automaticamente após a integração da API Dealer.
        Org Class: Informações serão carregadas automaticamente após a integração da API Dealer.
        Register Tax No (CNPJ): Informações serão carregadas automaticamente após a integração da API Dealer.
        Upper Org Code: Informações serão carregadas automaticamente após a integração da API Dealer.

Verificar o preenchimento destas informações no item 2.1.2.

Todas as abas possuem campo para ativar a API, intervalo de execução e data/hora do último envio da interface.

As APIs são disparadas através do robô do LinxDMS Web e são executadas conforme a data da última atualização e intervalo de execução definido.

2.1.1. Auth

Credenciais de Vendas:

           App Id: Solicitar as informações para a BYD
           App Secret: Solicitar as informações para a BYD
           Url Token: Preencher o campo com a URL https://uscrm.byd.com/api/open_api/get_token

2.1.2. Dealer :

 Url Dealer : Preencher o campo com  https://uscrm.byd.com/openapi/dataAnalysis/v1/getOrgInfo 

Para buscar os dados do Dealer (Org Code, Org Name, Org Class), utilizar o botão de lupa ao lado do campo Org Code.

2.1.3.Leads => Em desenvolvimento, não ativar 

2.1.4.Vehicles

Esta API executa o cadastramento e atualização de preços de modelos.

OBS: Conforme definido com BYD, usaremos o ConfigureCode como código do modelo.
A descrição será composta pela VersionName – AppearanceColor – InteriorColor.

Para atualização dos preços serão usados os registros da SalesPrice.  

Preencher o campos abaixo:

      Url Product: https://uscrm.byd.com/openapi/productMasterData/getProductMasterData 

      Url Price: https://uscrm.byd.com/openapi/productMasterData/productPrice 

      Url Vehicle Information : https://uscrm.byd.com/openapi/productMasterData/getCarInfoByVin 

      Modelo Serviço: modelo de serviço padrão usado para cadastrar o modelo 

      Fórmula Padrão: Fórmula de custeio padrão para cadastrar o modelo 

      Família Padrão: Família padrão para cadastrar o modelo 

ATENÇÃO: Após a execução da API é necessário ajustar os modelos dos veículos em estoque, para usar o novo padrão de códigos (Ver item 6 deste documento).  

2.1.5. Retail Order

=> API responsável pelo envio das propostas e notas fiscais.

Quando uma proposta é Enviada para Aprovação, é enviada para BYD. Neste momento também é enviada a Atribuição do Veículo desta proposta.

Quando a Nota Fiscal é emitida é enviada a informação da Nota Fiscal para a BYD.

O registro de Entrega do veículo é enviado quando a entrega do veículo for confirmada (item 5.4 deste documento).

Ao cancelar uma Proposta, cancelar uma Nota Fiscal ou fazer uma Devolução de Venda, é enviada a informação do seu cancelamento para a BYD.

Informações a preencher (API'S)

        Url Order Detail (Proposta): https://uscrm.byd.com/openapi/retail/v2/saveOrderDetail

        Url Order Delivery (Entrega): https://uscrm.byd.com/openapi/retail/v2/deliveryVehicle

        URL Assigne Vehicle Report (Atribuição Veículo) : https://uscrm.byd.com/openapi/retail/v2/assignVehicle

        URL Invoice Report (Nota Fiscal) :  https://uscrm.byd.com/openapi/retail/v2/retailOrderInvoice

        URL Cancel Report (Cancelamento Proposta/Cancelamento NF/Devolução NF): https://uscrm.byd.com/openapi/retail/v2/cancelOrder

2.1.6. Stock

API responsável pelo envio do inventário de veículos para  BYD.  Necessário fazer a configuração da situação do veículo (item 1.1) .

Quando a API é disparada serão enviados os veículos conforme as situações mapeadas. O veículo só é enviado novamente caso haja alteração no seu status. (Em Trânsito, Em Estoque, Vendido) .   

Url Stock: https://uscrm.byd.com/openapi/dataAnalysis/v1/manageInventory 

Url Warehousecode: https://uscrm.byd.com/openapi/dataAnalysis/v1/manageWarehouseCode

2.2. Telas de Monitoramento:

2.2.1 Inventário

No menu Fabrica > BYD > Logs Detalhados Inventário, é possível verificar em detalhes a situação de cada veículo (chassi) . 
 

2.2.2 Retail Order

No menu Fabrica > BYD > Monitoramento Retail Order, é possível verificar os envios das propostas/notas/entregas/cancelamentos de Veículos Novos.

Nesta opção também é possível Reenviar uma interface, se houve algum erro no envio, através da opção 'Reenviar Avulso'.

ATENÇÃO:

A ordem de envio das interfaces para a BYD é :

Proposta > Atribuição > Nota Fiscal > Entrega

Proposta > Atribuição > Nota Fiscal > Cancelamento ou Devolução

Proposta > Atribuição > Cancelamento Proposta

Ao reenviar a Proposta, será feito o reenvio também da Atribuição, Nota e Entrega ou Cancelamento/Devolução pendentes ou com erro.

Ao reenviar a Nota Fiscal, será feita o reenvio da Proposta, Atribuição e do Cancelamento/Devolução pendentes ou com erro.

Se não houve venda e a proposta foi cancelada, ao reenviar a Proposta será feito o reenvio também da Atribuição e do Cancelamento da Proposta.

E assim será o procedimento para todas as interfaces.

Portanto, selecione para o reenvio apenas uma das interfaces.

Será possível também enviar uma interface que por algum motivo não foi enviada automaticamente pelo Robô, na aba 'Envio Manual'.

Basta selecionar uma opção em 'Interfaces não enviadas automaticamente', selecionar o registro e clicar em 'Enviar Avulso'.

Após o envio, o resultado da integração poderá ser conferido na aba 'Consulta/Reenvio'.

ATENÇÃO:

• O envio manual dos pedidos através desta opção só poderá ser feito se o mesmo não foi incluído no Portal da BYD.

• Só serão apresentadas as interfaces que não foram integradas automaticamente pelo robô do LinxDms E que a interface anterior tenha sido integrada com sucesso.

Por exemplo, se existe uma nota fiscal que não foi integrada, mas sua proposta também não foi integrada, então a nota não será retornada na Pesquisa.

Deverá ser feita a pesquisa selecionando a opção 'Proposta' neste caso. Assim ao enviar a Proposta, a nota também será enviada.

A ordem de envio das interfaces para a BYD é :

Proposta > Atribuição > Nota Fiscal > Entrega

Proposta > Atribuição > Nota Fiscal > Cancelamento ou Devolução

Proposta > Atribuição > Cancelamento Proposta

Ao enviar a Proposta, será feito o envio também da Atribuição, Nota e Entrega ou Cancelamento/Devolução pendentes ou com erro.

Ao enviar a Nota Fiscal, será feita o envio da Proposta, Atribuição e do Cancelamento/Devolução pendentes ou com erro.

Se não houve venda e a proposta foi cancelada, ao enviar a Proposta será feito o envio também da Atribuição e do Cancelamento da Proposta.

E assim será o procedimento para todas as interfaces.

 
 2.2.3. Warehouse Codes

Para enviar os veículos em estoque é necessário cadastrar um Warehouse Code na BYD.

Este código BRA272409-13-1-2 é formado por : 

BRA272409 => org code 
13=> empresa 
1=> revenda  
2=> status (1= estoque, 2 = em trânsito, 3 =vendido)

Este código é cadastrado automaticamente pelo sistema toda vez que um veículo mudar de status.

Para monitoramento dos códigos já cadastrados existe a tela no Fábrica > BYD > Manutenção de Warehousecode

3. Logs de Monitoramento

Todos os processos são registrados na tela de consulta de log Web. 

Configuração > Consulta Log Web

4. Fluxo de ativação das APIS  

4.1. Preencher o Org Code,  Credenciais de Vendas e Urls das abas Auth e Dealer, ativar a Integração API BYD. 

4.2. Selecionar os dados do Dealer  através do botão 'Lupa' do Ord Code e verificar se os mesmos foram preenchidos.

Salvar as alterações através do botão 'Salvar'.

 4.3. Ativar a integração Stock, aguardar execução e verificar os logs e a tela de monitoramento dos códigos Warehouse (item 2.2.3). 

4.4. Preencher os campos de configuração padrão e ativar a integração Vehicles.

4.6. Ativar a integração Retail Order.  

5. Fluxo de Envio Retail Order 

Pre-Requisitos:

Para que a integração dos pedidos ocorra sem retorno de erro pela BYD temos que primeiramente:

• Ter os dados obrigatórios de clientes informados : Nome, Telefone e Email
• Atualizar os modelos dos veículos que já estão em estoque, para usar o novo padrão de códigos de modelos da BYD (Ver item 6 deste documento)
• Na nota de entrada do veículo, o modelo do veículo deve ser informado com o novo padrão de códigos de modelos da BYD (botão 'Buscar Modelo BYD')

5.1. Efetuar a importação do XML de nota de entrada de veículos. 

Menu Veículos > Transações > Entradas > Recebimento de Veículos:

Para a integração de Venda com a BYD, o modelo do veículo deve ser o definido pela BYD.

Para isto devemos buscar o modelo BYD do veículo, através da botão 'Buscar Modelo BYD'.

Pre-Requisito : parametrizar urls de veículos da BYD - ver seção '2.1.4.Vehicles' deste documento.

Na aba Veículos também é possível fazer esta atualização, através do mesmo botão.

Selecionar o modelo (ConfigureCode) correspondente ao chassi que está sendo dada a entrada. 

Após a geração da nota de entrada, na próxima execução da API de Stock, será enviado um registro para BYD com a situação do chassi: 

5.2. Abrir uma proposta usando o chassi que foi enviado pela interface Stock. 
 

Nesta opção será  possível anexar os comprovantes de Pagamento e Residência do cliente, para envio a BYD na interface de envio de Pedido (Order Detail):

Atenção: esta opção não é obrigatória para a integração com a BYD.

Atentar para que o cliente esteja com a informação de nome, telefone e email.

Após a proposta ser enviada para aprovação, será enviado um registro informando a geração de pedido (Order Detail) para a BYD. 

Será enviado também a Atribuição do Chassi à proposta (interface Assign Vehicle).

 5.3. Após aprovação gerencial e financeira enviar ao frente de caixa e emitir a nota. 

Após a emissão da Nota Fiscal, na próxima execução do robô será enviado um registro a BYD informando a confirmação da nota fiscal (Invoice Report).

5.4 Configurar a agenda de entrega de veículo conforme descrito no Agendamento Automático de Entrega de Veículos - Automotivo - Linx Share. 

Após a emissão da nota será efetuada agenda automática de entrega.

Se não tiver o processo de entrega automática, poderá ser incluída manualmente a entrega.

Confirmar a entrega.

 Após a confirmação, na próxima execução do robô será enviado um registro a BYD informando a confirmação da entrega (Order Delivery).

5.5. Caso haja Cancelamento de Proposta, Cancelamento de Nota Fiscal ou Devolução de Venda, na próxima execução do robô será enviado um registro a BYD informando o cancelamento do pedido (Cancel Report).

6. Processo Auxiliar para alteração dos modelos. 

Pre-Requisito : parametrizar urls de veículos da BYD - ver seção '2.1.4.Vehicles' deste documento.

 Menu Veículos > Cadastros > Veículos: 

Importante selecionar apenas a revenda que está sendo utilizada a API e somente veículos NOVOS.

Marcar a opção Gerar Lista de veículos para alterar modelo (o usuário deve ter permissão para a função 68).

Ao clicar em 'Procurar' será apresentada uma nova aba 'Altera Modelo'. 

Será pesquisado na API da BYD o modelo (ConfigureCode) correto que deve ser associado a cada veículo (chassi)

Caso o chassi não esteja cadastrado na BYD ou o novo modelo não esteja cadastrado no LinxDMS será apresentada a mensagem correspondente. 

Selecionar os veículos que deseja alterar e clicar em 'Altera Modelos'. 

Em caso de dúvidas sobre o conteúdo deste documento, entre em contato com o Suporte Nacional, através do site cliente.linx.com.br.