Esta documentação visa detalhar como a integração de um Parceiro Logístico ou Intermediário Integrador devem ser realizadas por meio da funcionalidade de Extensibilidade Logística da plataforma Linx Commerce.
É responsabilidade do Parceiro Logístico disponibilizar uma API web via HTTPS, que seja capaz de receber e devolver dados por meio de JSON, seguindo a implementação dos endpoints conforme o protocolo estabelecido abaixo.
Deixa-se claro desde já que a não-conformidade da entrega do Parceiro Logístico implica em uma quebra de contrato do Parceiro Logístico com a Linx Commerce sem qualquer ônus da Linx Commerce.
A Extensibilidade Logística funciona em 3 grandes partes:
- Configuração de Meio de Entrega
- Teste de Credenciais
- Cotação de Frete
Um Meio de Entrega é um conjunto de configurações de define como uma integração de Frete deve ser realizada.
Um lojista Linx Commerce pode ter diversos Meios de Entrega configurados na Extensibilidade Logística. Por exemplo:
- Correios Sedex
- Correios PAC
- Correios Sedex10
Cada um desses meios de entrega é independente um do outro e pode ter seu próprio conjunto de configurações própria.
A Extensibilidade Logística permite à Parceiros ofertar diversos Providers de Frete, que são as integrações que esse Parceiro conhece e deseja disponibilizar para os lojistas Linx Commerce.
- Exemplos de Providers de Frete seriam: Correios, Jadlog, Total Express, Intelispot, Frete Rápido, etc.
Essas integrações com Providers podem precisar evoluir com o tempo; portanto a Extensibilidade Logística também conta com a possibilidade de definir Versões de Integração com o Provider de Frete.
- Versões de Integração para Providers de Frete podem ser identificados simplesmente por "v1", "v2", "v3" ou estarem relacionadas com a tecnologia utilizada, como "SOAP" ou "RESTv1", por exemplo.
Consequentemente, cada Versão de Integração pode contar com seu próprio conjunto de Parâmetros ou Configurações que o lojista Linx Commerce deve definir para poder utilizar aquela Versão de Integração.
- Exemplo de Configurações podem ser desde Dados de Autenticação junto àquela Versão/Provider ou até mesmo Parametrizações Gerais, que personalizam o comportamento da Cotação de Frete nesse Meio de Entrega.
O Linx Commerce permite ao usuário que está configurando o Meio de Entrega validar os Parâmetros/Configurações fornecidos para determinar se elas "funcionam" no Provider/Versão de Integração.
Dessa forma, o usuário pode facilmente saber se alguma informação que foi fornecida incorretamente ou não é válida.
A etapa final de integração de Extensibilidade Logística. É por meio da Cotação de Frete que o Linx Commerce solicita estimativas de Preço e Prazo aos Parceiros. O Linx Commerce fornece os dados de Itens do Carrinho, Estoque de Origem e CEP de Destino. Com base nessas informações, o Parceiro deve retornar a estimativa de Preço e Prazo que poderá ser apresentado ao consumidor final no e-commerce.
Especificação do Protocolo
Para que um Parceiro Logístico ou Intermediário Integrador implementem o protocolo definido pela Extensibilidade Logística, eles devem seguir as instruções conforme cada uma das seguintes documentações: