Cotações de Frete
POST http://dominiotransportadora.com.br/api/v1/cotacao/
Disparo de dados para cotação de frete.
Se desejar integrar as cotações, sua transportadora pode preparar um webservice para receber a qualquer momento os dados abaixo e retornar as cotações.
A Frete Rápido irá disparar o conjunto de dados abaixo, através de uma requisição.
Envio:
Parâmetros do corpo da requisição:
Descrição | Formato / Exemplo | Informado | |
---|---|---|---|
remetente | Objeto com alguns dados do remetente/origem | Objeto em json | * |
cnpj | CNPJ do remetente da carga | String de 14 caracteres sem formatação | * |
inscricao_estadual | Inscrição Estadual do remetente da carga | String | * |
cep | CEP do remetente / origem da carga | String de 8 caracteres sem formatação | * |
destinatario | Objeto com alguns dados do destinatário | Objeto em json | * |
cnpj_cpf | CNPJ do destinatário da carga (se Pessoa Jurídica). Caso esteja vazio, considerar o destinatário como Pessoa Física. | String de 11 ou 14 caracteres sem formatação | Se destinatário for Pessoa Jurídica |
inscricao_estadual | Inscrição Estadual do destinatário da carga (se Pessoa Jurídica) | String | Se destinatário for Pessoa Jurídica |
cep | CEP do destinatário / destino da carga | String de 8 caracteres sem formatação | * |
expedidor | Objeto com alguns dados do expedidor (se houver) | Objeto em json | Se houver expedidor |
cnpj | CNPJ do expedidor da carga | String de 14 caracteres sem formatação | Se houver expedidor |
inscricao_estadual | Inscrição Estadual do expedidor da carga | String | Se houver expedidor |
cep | CEP do expedidor da carga | String de 8 caracteres sem formatação | Se houver expedidor |
carga | Objeto com dados gerais da carga (somatório dos volumes) | Objeto em json | * |
valor_total | Valor total da carga (todos os volumes) | Numérico (float) | * |
cubagem | Cubagem total calculada pelas dimensões de todos os volumes que compõem a carga. Fator de cubagem: 300 Kg / M³. | Numérico (float) | * |
peso_cubado | Peso cubado da carga (todos volumes) | Numérico (float) | * |
peso_real | Peso real da carga (todos volumes) | Numérico (float) | * |
total_volumes | Quantidade total dos volumes informados | Numérico (inteiro) | * |
volumes | Array com um ou mais objetos dos volumes informados | Array em json | * |
Objeto com as características do volume informado | Objeto em json | * | |
tipo | Tipo do volume informado (vide tabela de tipos de volumes) | Numérico (inteiro) | * |
altura | Altura do volume unitário em metros | Numérico (float) | * |
largura | Largura do volume unitário em metros | Numérico (float) | * |
comprimento | Comprimento do volume unitário em metros | Numérico (float) | * |
quantidade | Quantidade de volumes iguais e do mesmo tipo | Numérico (inteiro) | * |
peso_real | Peso total (em Kg) dos volumes informados. Exemplo: 6 volumes com 0.5 Kg cada, o valor informado será de 3 Kg | Numérico (float) | * |
valor | Valor total do conjunto de volumes informados. Exemplo: 6 volumes custando R$20,00 cada, então o valor informado será R$120,00 | Numérico (float) | * |
tipo_cobranca | Tipo de cobrança do frete (CIF ou FOB) | Numérico (inteiro): 1 (CIF) ou 2 (FOB) | * |
token | Token de integração gerado pela Frete Rápido | String de 32 caracteres | * |
* Informados sempre
Exemplo de envio:
{
"modal": "",
"tipo_cobranca": 0,
"remetente": {
"cnpj": "",
"inscricao_estadual": "",
"cep": ""
},
"expedidor": {
"cnpj": "",
"inscricao_estadual": "",
"cep": ""
},
"destinatario": {
"cnpj_cpf": "",
"inscricao_estadual": "",
"cep": ""
},
"carga": {
"total_volumes": 0,
"valor_total": 0.00,
"cubagem": 0.00,
"peso_cubado": 0.00,
"peso_real": 0.00
},
"volumes": [
{
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"valor": 0.00,
"peso_real": 0.00,
"tipo": 0
},
{
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"valor": 0.00,
"peso_real": 0.00,
"tipo": 0
}
],
"token": ""
}
A resposta deve ser no formato de um array de objetos contendo o conjunto de dados a seguir como resposta das cotações:
Nome | Descrição | Formato / Exemplo | Retornado |
---|---|---|---|
preco | Preço do frete | Numérico (float) | Sempre |
prazo_entrega | Prazo em dias úteis para a realização da entrega | Numérico (inteiro) | Sempre |
servico | Tipo de serviço para a realização da entrega | Texto (string) | Sempre |
descricao_servico | Descrção do serviço para a realização da entrega | Texto (string) | Opcional |
validade_cotacao | Validade da proposta da cotação | Date ("YYYY-MM-DD") | Sempre |
identificador | Identificador interno da transportadora para cotação | Texto (string) | Opcional |
Exemplo de resposta:
[
{
"preco": 0.00,
"prazo_entrega": 0,
"servico": "",
"descricao_servico": null,
"validade_cotacao": "",
"identificador": null
},
{
"preco": 0.00,
"prazo_entrega": 0,
"servico": "",
"descricao_servico": null,
"validade_cotacao": "",
"identificador": null
}
]
- A Frete Rápido espera conectar-se ao webservice da transportadora e obter a resposta da cotação em no máximo 300 milissegundos após realizar a requisição.
Boas práticas:
- Responder as requisições da Frete Rápido dentro do tempo esperado. Se a resposta levar mais tempo do que estabelecido, será automaticamente desconsiderada e não participará da cotação.