Suporte

O que é?

Para possibilitar a integração com qualquer transportadora ou HUB, nós desenvolvemos um aplicativo chamado Gateway de Fretes. Porém, para utilizar esse aplicativo é necessário que seja respeitada a padronização de requisição e de resposta esperada.

Mas, o que é uma requisição? Pode ser definida como a comunicação entre dois ou mais servidores. No caso prático da consulta de frete, há uma requisição informando para o servidor da transportadora/HUB as informações necessárias para o cálculo e depois há uma resposta enviada para nós com as informações de valor, prazo e etc.

O desenvolvimento da integração deve ser realizado pela transportadora ou pelo HUB que você irá utilizar para efetuar as cotações de frete em sua loja.

1 – Padronização da Requisição:

Na requisição para a cotação de Frete realizada pela plataforma, sempre será seguida a seguinte padronização com as seguintes variáveis, no formato JSON e o tipo será POST:

token: Token de autenticação informado pela transportadora;

cep_origem: CEP da loja, configurado em Configurações >> Dados da loja;

cep_destino: CEP informado pelo cliente no momento da cotação;

Em seguida, será enviado um conjunto contendo as informações todos os produtos que compõem o pedido, onde:

quantidade: Total de unidades de um mesmo produto;

preco: Valor de venda do produto na loja;

peso: Peso em KG configurado no produto;

largura: Largura em CM configurada no produto;

altura: Altura em CM configurada no produto;

comprimento: Comprimento em CM configurado no produto;

sku: SKU do produto na loja;

No exemplo abaixo, há uma situação onde há somente um produto na cotação. Caso existam produtos diferentes no carrinho do cliente, o objeto que está dentro de “produtos” será replicado:

Exemplo:

{
  "token": "SI6IkFQSS5QT05UT1gifQ",
  "cep_origem":"13322423",
  "cep_destino":"91920020",
  "produtos":[
    {
      "quantidade": 1,
      "preco": 179.90, 
      "peso": 0.085,
      "largura": 30,
      "altura": 2,
      "comprimento": 25,
      "sku":"SKU-PROD1"
    }   
  ]
}

Se o cliente realizar a cotação de mais de uma unidade de um mesmo produto, a variável quantidade irá se modificar de acordo com a seleção do cliente, porém os demais campos continuarão os mesmos pois compreendem a medida/valor unitário do produto.

Após isso, a transportadora realiza a aplicação das regras de frete e de cotação e envia uma resposta para nós de acordo com o tópico abaixo.

2 – Padronização de Resposta:

Na resposta da cotação realizada a plataforma espera pelos dados de acordo com as seguintes variáveis e no formato JSON:

id_cotação: Id da cotação no sistema da transportadora;

Em seguida deve ser enviado um Array chamado cotacao contendo todas as cotações que retornaram na requisição anterior. Não há limite de objetos que podem ser enviados para nós nesta situação.

codigo: ID da transportadora;

transportadora: Nome da transportadora que será mostrada ao cliente;

servico: Tipo do serviço. Será mostrado ao cliente; Ex: “Expresso”, “Econômico”

valor: Valor do frete;

peso: Peso total do pedido;

prazo: Prazo de entrega do pedido;

frete_gratis: Se o pedido for grátis deve ser enviado “1” nesta variável. Caso contrário “0”;

: Imagem que será mostrada no carrinho do cliente. Caso nada seja enviado nesta variável, iremos utilizar a configurada na plataforma (mais detalhes no item 3.3);

Das variáveis acima é obrigatório somente o envio dos seguintes:

transportadora, valor, peso, prazo e frete_gratis

Exemplo:

{
    "id_cotacao": "1d5605a9-649b-464d-bd1b-8621de7449dc",
    "cotacao": [
        {
            "codigo": "1234",
            "transportadora": "Correios",
            "servico": "PAC",
            "valor": 15.35,
            "peso": 2,
            "prazo": 1,
            "frete_gratis": 0,
            "": ""
        }
    ]
}

Caso você tenha alguma dúvida referente a padronização desta funcionalidade entre em contato conosco através do e-mail [email protected]

3 – Configuração do aplicativo na plataforma:

3.1 – Para configurar o aplicativo na sua loja, você precisará acessar Aplicativos > Formas de envio > Gateway de Fretes:

3.2 – Em seguida, Clique em “Adicionar” e você será direcionado para a página de cadastro do Gateway:

3.3 – Na página de cadastro, você verá as seguintes configurações:

Ativo: Habilite a caixinha para deixar este frete/hub disponível na loja;

Nome: Aqui você irá definir um nome para o frete da transportadora. Este campo é somente para você identificar a transportadora/hub. Este campo não é mostrado para o cliente final;

Endpoint: URL informada pela transportadora/hub para a cotação;

App Key: Chave de autenticação informada;

Imagem: Caso não seja enviada uma através da API, nós iremos considerar a cadastrada neste campo para a forma de envio.

3.4 – Após configurar estes campos acima, você ainda tem a possibilidade de configurar as regiões atendidas e definir um prazo extra. Além de acrescentar um valor ou percentual ao preço do frete:

Para adicionar uma região, clique em adicionar região:

E em seguida configure os campos abaixo. Os campos destacados são os campos obrigatórios:

Após configurar e salvar a região, salve a configuração do Frete e o mesmo já estará funcionando em sua loja caso a integração da transportadora/hub esteja seguindo a padronização.