Documentor Guide

1.API #

Api do sistema Frete Click

Nossa API visa a integração com diversas plataformas.

Utilizado principalmente por ERP´s ou sistemas próprios.

Para lojas virtuais e merketplaces, consulte nossos módulos:

Módulos de Frete para E-Commerce

Modulos de Frete para Marketplaces

1.1.Chave da API #

Existem duas formas de conseguir sua chave de API.

  1. Acessando seu painel de controle, entrando em seu perfil, na aba usuários conforme a figura abaixo:

  2. Através do método /user/create-account na própria API 

1.2.Criar Conta #

 

URL: https://api.freteclick.com.br
POST: /user/create-account.json

ParâmetroDescriçãoTipo
nameNome da Pessoa que Utilizará o sistemastring
usernameUsuário utilizado para fazer o login no painelstring
dddDDD do Telefone de contatoint (2)
phoneTelefone utilizado para contatoint (9)
emailEmail do usuário em questãostring
passwordSenha utilizada no sistemastring
confirm-passwordConfirmação da senha. Deve ser igual ao password.string

Retorno:

{  
   "response":{  
      "data":{  
         "id":384,
         "username":"usuario.teste",
         "apikey":"f8e48d7522e0e24654792f8acca1ac9c2b"
         "people":{  
            "id":1
         },
         "log":null
      },
      "count":1,
      "success":true
   }
}

2.Cotação #

URL: https://api.freteclick.com.br
POST: /sales/shipping-quote.json

 

ParâmetroDescriçãoTipo
nameNome da Pessoa que Utilizará o sistemastring
orderOrdenação dos dados da cotaçãoenum(‘total’,’deadline’)
phoneTelefone utilizado para contato com DDDint (11)
emailEmail do usuário em questãostring
product-total-priceValor total da nota fiscalfloat
product-typeTipo de produto a ser entregue. Normalmente uma categoria.string
product-package[0][qtd]Quantidade do produtoint
product-package[0][weight]Peso do produtofloat
product-package[0][height]Altura do produtofloat
product-package[0][width]Largura do Produtofloat
product-package[0][depth]Profundidade do Produtofloat
cep-originCEP onde será realizada a coletaint (8)
street-originLogradouro onde será realizada a coletastring
address-number-originNúmero do endereço onde será realizada a coletastring
complement-originComplemento do endereço onde será realizada a coletastring
district-originBairro onde será realizada a coletastring
city-originCidade onde será realizada a coletastring
state-originEstado onde será realizada a coletastring (2)
country-originPaís onde será realizada a coletastring
cep-destinationCEP onde será realizada a entrega int (8)
street-destinationLogradourostring
address-number-destinationNúmero onde será realizada a entregastring
complement-destinationComplemento do endereço onde será realizada a entregastring
district-destinationBairro onde será realizada a entregastring
city-destinationCidade onde será realizada a entregastring
state-destinationEstado onde será realizada a entregastring (2)
country-destinationPaís onde será realizada a entregastring

 

Retorno:

{
   response:{
      data:{
         request:{
            name:"Nome",
            email:"email@exemplo.com",
            phone:"(11) 3535-3535",
            product-type:[
               "Móveis"
            ],
            product-type-id:"",
            product-total-price:"1",
            product-package:[
               {
                  qtd:"1",
                  weight:"1",
                  height:"1",
                  width:"1",
                  depth:"1"
               }
            ],
            cep-origin:"07060000",
            street-origin:"Endereço",
            address-number-origin:"número",
            complement-origin:"Casa 2",
            district-origin:"Bairro",
            city-origin:"Guarulhos",
            state-origin:"SP",
            country-origin:"Brasil",
            cep-destination:"07060000",
            street-destination:"Endereço",
            address-number-destination:"1",
            complement-destination:"Casa 3",
            district-destination:"Bairro",
            city-destination:"Guarulhos",
            state-destination:"SP",
            country-destination:"Brasil",
            order:"total",
            domain:"api.freteclick.com.br",
            address-nickname:"Endereço Principal",
            city-origin-id:1,
            city-destination-id:1,
            weight:1,
            cubage:300,
            final-weight:300
         },
         quote:[
            {
               delivery-restricted:false,
               logo:null,
               carrier-name:"TRANS WELL'S EXPRESSO RODOVIARIO LTDA",
               carrier-alias:"TRANS WELL'S",
               carrier-active:"carrier-enabled",
               carrier-logo:null,
               deadline:5,
               total:99.908231707317,
               tax:{
                  12502:{
                     tax-name:"GRIS",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.2,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.002
                  },
                  12767:{
                     tax-name:"FRETE",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:54.28,
                     minimum-price:0,
                     weight:9999999,
                     subtotal:54.28
                  },
                  12929:{
                     tax-name:"pedagio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:6.18,
                     minimum-price:100,
                     weight:9999.999,
                     subtotal:18.54
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:15.985317073171
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:11.100914634146
                  }
               },
               quote-id:65477,
               order-id:14129
            },
            {
               delivery-restricted:false,
               logo:null,
               carrier-name:"Transportadora Plimor Ltda",
               carrier-alias:"PLIMOR TRANSPORTES",
               carrier-active:"carrier-enabled",
               carrier-logo:null,
               deadline:5,
               total:168.86112804878,
               tax:{
                  12932:{
                     tax-name:"TDA",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.3,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.003
                  },
                  12933:{
                     tax-name:"TDE",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.3,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.003
                  },
                  14264:{
                     tax-name:"GRIS",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.3,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.003
                  },
                  14267:{
                     tax-name:"pedagio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:4.6,
                     minimum-price:100,
                     weight:9999999.999,
                     subtotal:13.8
                  },
                  14280:{
                     tax-name:"FRETE",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:108.19,
                     minimum-price:0,
                     weight:9999999.999,
                     subtotal:108.19
                  },
                  14308:{
                     tax-name:"FRETE EXCEDENTE",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:1.082,
                     minimum-price:0,
                     weight:9999999.999,
                     subtotal:1.082
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:27.017780487805
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:18.762347560976
                  }
               },
               quote-id:65476,
               order-id:14129
            },
            {
               delivery-restricted:false,
               logo:"/user/profile-image/id/814/logo.png",
               carrier-name:"SS Delivery Express Solucoes Logisticas Ltda - Me",
               carrier-alias:"SS Delivery",
               carrier-active:"carrier-enabled",
               carrier-logo:"//app.freteclick.com.br/user/profile-image/id/814/logo.png",
               deadline:2,
               total:170.53902439024,
               tax:{
                  11565:{
                     tax-name:"GRIS",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.2,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.002
                  },
                  11566:{
                     tax-name:"Pedágio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:4.1,
                     minimum-price:100,
                     weight:9999999.999,
                     subtotal:12.3
                  },
                  11589:{
                     tax-name:"Frete peso",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:43,
                     minimum-price:0,
                     weight:9999999.999,
                     subtotal:43
                  },
                  11591:{
                     tax-name:"Frete Excedente",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.23,
                     minimum-price:0,
                     weight:100,
                     subtotal:69
                  },
                  11731:{
                     tax-name:"Frete Valor",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.2,
                     minimum-price:0,
                     weight:9999999,
                     subtotal:0.002
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:27.286243902439
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:18.948780487805
                  }
               },
               quote-id:65475,
               order-id:14129
            },
            {
               delivery-restricted:false,
               logo:"/user/profile-image/id/117/TDB.jpg",
               carrier-name:"TDB Transporte e Distribuicao de Bens Ltda",
               carrier-alias:"TDB Transportes",
               carrier-active:"carrier-enabled",
               carrier-logo:"//app.freteclick.com.br/user/profile-image/id/117/TDB.jpg",
               deadline:2,
               total:219.51219512195,
               tax:{
                  12349:{
                     tax-name:"Frete Peso",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:49.5,
                     minimum-price:0,
                     weight:9999999,
                     subtotal:49.5
                  },
                  12350:{
                     tax-name:"Frete Excedente ",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.32,
                     minimum-price:0,
                     weight:100,
                     subtotal:96
                  },
                  12433:{
                     tax-name:"Pedágio ",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:3.6,
                     minimum-price:100,
                     weight:9999999,
                     subtotal:10.8
                  },
                  12435:{
                     tax-name:"Frete Valor",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.2,
                     minimum-price:3.7,
                     weight:null,
                     subtotal:3.7
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:35.121951219512
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:24.390243902439
                  }
               },
               quote-id:65478,
               order-id:14129
            },
            {
               delivery-restricted:false,
               logo:"/user/profile-image/id/201/MMA_CARGAS.jpg",
               carrier-name:"REDIVIX - SP TRANSPORTES LTDA - EPP",
               carrier-alias:"MMA Cargas",
               carrier-active:"carrier-enabled",
               carrier-logo:"//app.freteclick.com.br/user/profile-image/id/201/MMA_CARGAS.jpg",
               deadline:1,
               total:227.39131097561,
               tax:{
                  8211:{
                     tax-name:"TAS",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:3.5,
                     minimum-price:0,
                     weight:null,
                     subtotal:3.5
                  },
                  8212:{
                     tax-name:"Taxa de Despacho",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:23.9,
                     minimum-price:0,
                     weight:null,
                     subtotal:23.9
                  },
                  8213:{
                     tax-name:"Pedágio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:3.85,
                     minimum-price:100,
                     weight:1000000,
                     subtotal:11.55
                  },
                  8214:{
                     tax-name:"Ad. Valorem",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.3,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.003
                  },
                  8215:{
                     tax-name:"GRIS",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.15,
                     minimum-price:2.8,
                     weight:null,
                     subtotal:2.8
                  },
                  8220:{
                     tax-name:"Frete peso",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:30.99,
                     minimum-price:0,
                     weight:100000,
                     subtotal:30.99
                  },
                  8264:{
                     tax-name:"Frete Excedente",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.31,
                     minimum-price:0,
                     weight:100,
                     subtotal:93
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:36.382609756098
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:25.265701219512
                  }
               },
               quote-id:65481,
               order-id:14129
            },
            {
               delivery-restricted:false,
               logo:"/user/profile-image/id/205/TRANSITOBRASIL.jpg",
               carrier-name:"Hb Transportes e Logistica Eireli",
               carrier-alias:"Transito Brasil",
               carrier-active:"carrier-enabled",
               carrier-logo:"//app.freteclick.com.br/user/profile-image/id/205/TRANSITOBRASIL.jpg",
               deadline:1,
               total:236.87080792683,
               tax:{
                  7171:{
                     tax-name:"GRIS",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.25,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.0025
                  },
                  7279:{
                     tax-name:"Frete peso",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:60,
                     minimum-price:0,
                     weight:200000,
                     subtotal:60
                  },
                  7288:{
                     tax-name:"Frete Excedente",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.34,
                     minimum-price:0,
                     weight:200,
                     subtotal:102
                  },
                  7315:{
                     tax-name:"Pedágio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.022,
                     minimum-price:4.38,
                     weight:0.001,
                     subtotal:6.6
                  },
                  11735:{
                     tax-name:"Tas",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:4.05,
                     minimum-price:0,
                     weight:null,
                     subtotal:4.05
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:37.899329268293
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:26.318978658537
                  }
               },
               quote-id:65480,
               order-id:14129
            },
            {
               delivery-restricted:false,
               logo:"/user/profile-image/id/649/LL.jpg",
               carrier-name:"Edne Novaes Rocha - ME",
               carrier-alias:"L&L Transportes Express",
               carrier-active:"carrier-enabled",
               carrier-logo:"//api.freteclick.com.br/user/profile-image/id/649/LL.jpg",
               deadline:3,
               total:239.41234756098,
               tax:{
                  11251:{
                     tax-name:"Seguro",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.3,
                     minimum-price:0,
                     weight:9999999.999,
                     subtotal:0.003
                  },
                  11253:{
                     tax-name:"Gris",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.2,
                     minimum-price:0,
                     weight:9999999.999,
                     subtotal:0.002
                  },
                  11257:{
                     tax-name:"Pedágio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:5.5,
                     minimum-price:100,
                     weight:9999999.999,
                     subtotal:16.5
                  },
                  11258:{
                     tax-name:"Frete peso",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.26,
                     minimum-price:0,
                     weight:0.001,
                     subtotal:78
                  },
                  11260:{
                     tax-name:"Despacho",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:30,
                     minimum-price:0,
                     weight:null,
                     subtotal:30
                  },
                  11261:{
                     tax-name:"SEC/CAT",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:30,
                     minimum-price:0,
                     weight:null,
                     subtotal:30
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:38.305975609756
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:26.60137195122
                  }
               },
               quote-id:65482,
               order-id:14129,
               retrieve-tax:20
            },
            {
               delivery-restricted:false,
               logo:"/user/profile-image/id/211/ALFATRANSPORTES.jpg",
               carrier-name:"ALFA TRANSPORTES EIRELI",
               carrier-alias:"Alfa Transportes",
               carrier-active:"carrier-enabled",
               carrier-logo:"//api.freteclick.com.br/user/profile-image/id/211/ALFATRANSPORTES.jpg",
               deadline:2,
               total:333.59542682927,
               tax:{
                  7318:{
                     tax-name:"Taxa Administrativa",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:2.4,
                     minimum-price:0,
                     weight:null,
                     subtotal:2.4
                  },
                  7319:{
                     tax-name:"GRIS",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.15,
                     minimum-price:2.15,
                     weight:null,
                     subtotal:2.15
                  },
                  7320:{
                     tax-name:"AD VALOREM",
                     tax-type:"percentage",
                     tax-subtype:"invoice",
                     price:0.4,
                     minimum-price:0,
                     weight:null,
                     subtotal:0.004
                  },
                  7400:{
                     tax-name:"Frete peso",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:51.14,
                     minimum-price:0,
                     weight:10000,
                     subtotal:51.14
                  },
                  7911:{
                     tax-name:"TRT - SP",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:86,
                     minimum-price:0,
                     weight:1000000,
                     subtotal:86
                  },
                  8081:{
                     tax-name:"Cat",
                     tax-type:"fixed",
                     tax-subtype:null,
                     price:20.46,
                     minimum-price:0,
                     weight:100000,
                     subtotal:20.46
                  },
                  8195:{
                     tax-name:"Frete Excedente",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:0.23,
                     minimum-price:0,
                     weight:150,
                     subtotal:69
                  },
                  10245:{
                     tax-name:"Pedágio",
                     tax-type:"fixed",
                     tax-subtype:"kg",
                     price:4,
                     minimum-price:100,
                     weight:100000,
                     subtotal:12
                  },
                  tax-28:{
                     tax-name:"ICMS",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:18,
                     minimum-price:0,
                     subtotal:53.375268292683
                  },
                  plan-1:{
                     tax-name:"Taxa de conveniência",
                     tax-type:"percentage",
                     tax-subtype:"order",
                     price:12.5,
                     minimum-price:5,
                     subtotal:37.066158536585
                  }
               },
               quote-id:65479,
               order-id:14129
            }
         ],
         id:14129
      },
      count:31,
      success:true
   }
}
Olá, como podemos ajudar?
Powered by

Desenvolvido por Controle Online - Desenvolvimento de aplicativos

Hospedado por Go Infinite