Cotações de Frete
Depreciada
- Recomendamos o uso da nova API de Cotações de Frete.
POST https://freterapido.com/api/external/embarcador/v1/quote-simulator
Método que permite realizar cotação de frete.
Basta enviar os dados abaixo em uma requisição para a URL do método.
Envio:
Parâmetros do corpo da requisição:
| Nome | Descrição | Formato / Exemplo | Obrigatório |
|---|---|---|---|
| remetente | Objeto com alguns dados do remetente/origem | Objeto em json | * |
| cnpj | CNPJ do remetente da carga | String Numérica de 14 caracteres sem formatação | * |
| expedidor¹ | Objeto com alguns dados do expedidor | Objeto em json | Se houver expedidor |
| cnpj | CNPJ do expedidor da carga. Também será utilizado para realizar a consolidação de volumes com as caixas cadastradas na Frete Rápido. | String Numérica de 14 caracteres sem formatação | Se houver expedidor |
| endereco | Se houver expedidor | ||
| cep | CEP do expedidor da carga | String Numérica de 8 caracteres sem formatação | Se houver expedidor |
| destinatario | Objeto com alguns dados do destinatário | Objeto em json | * |
| tipo_pessoa | Define o tipo de destinatário (Pessoa Jurídica ou Pessoa Física) | Numérico (inteiro) 1 = pessoa física 2 = pessoa jurídica |
* |
| cnpj_cpf | CNPJ ou CPF do destinatário da carga | String Numérica 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 | String | Se destinatário for Pessoa Jurídica |
| endereco | Objeto com dados de endereço do destinatário da carga | Objeto em json | * |
| cep | CEP do destinatário / destino da carga | String de 8 caracteres sem formatação | * |
| 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/produto informado (vide tabela de tipos de volumes) | Numérico (inteiro) | * |
| sku | SKU do volume/produto informado | String | Opcional |
| tag | TAG do volume/produto informado | String | Opcional |
| descricao | Descrição do volume/produto informado | String | Opcional |
| quantidade | Quantidade de volumes/produtos iguais e do mesmo tipo | Numérico (inteiro) | * |
| altura | Altura em Metros do volume/produto unitário | Numérico (float) | * |
| largura | Largura em Metros do volume/produto unitário | Numérico (float) | * |
| comprimento | Comprimento em Metros do volume/produto unitário | Numérico (float) | * |
| peso | Peso total (em Kg) da quantidade de volumes informados. Exemplo: 6 volumes com 0,5kg cada, então o valor informado deve ser 3kg. | Numérico (float) | * |
| valor | Valor total da quantidade de volumes informados. Exemplo: 6 volumes custando R$20,00 cada, então o valor informado deve ser R$120,00. | Numérico (float) | * |
| volumes_produto | Quantidade de volumes do produto ao qual este volume pertence. Ex.: este volume percente a um jogo de sofá que é composto por quatro volumes no mesmo SKU, então o campo deve ser preenchido com 4. Usaremos esta informação para agrupar os volumes de um mesmo produto. | Numérico (inteiro) | Opcional |
| consolidar | Consolidar volume? Default: false | Boolean | Opcional |
| sobreposto | Sobrepor volume sobre outro? Default: false | Boolean | Opcional |
| tombar | Tombar volume? Default: false | Boolean | Opcional |
| filtro | Permite parametrizar o retorno das cotações | Numérico (inteiro) 1 = Retornar somente a oferta com menor preço 2 = Retornar somente a oferta com menor prazo de entrega3 = Retornar somente a oferta com menor preço e a de menor prazo (caso uma oferta possua menor preço e prazo, apenas ela retornará) |
Opcional |
| canal | Permite filtrar a regra de frete pelo canal | String (Texto) | Opcional |
| limite | Define a quantidade de cotações que deve retornar | Numérico (inteiro) | Opcional |
| codigo_plataforma | Informar código de sua plataforma. Solicite o código da sua plataforma à Frete Rápido. | String | * |
| cotacao_plataforma | Identificador da cotação na plataforma de e-commerce. Podendo agilizar a consulta de valores em caso de várias chamadas do mesmo carrinho de compras. | Numérico (inteiro) | Opcional |
| token | Token de integração | String de 32 caracteres | * |
| retornar_consolidacao | Caso true retornará os volumes consolidados | Boolean | Opcional |
*Obrigatório
¹ Expedidor é utilizado quando a transportadora deve coletar a mercadoria em outro local diferente do local do remetente, muito utilizado por empresas onde o remetente é de outro estado, mas a mercadoria deve ser coletada no estado onde se encontra a transportadora. Exemplo: Uma empresa remetente de RS, transportadora de SP, mercadoria deve ser coletada na filial da empresa que está em SP para ser entregue em BA. Nesse caso, o expedidor deve ser a filial de SP para que o conhecimento de transporte saia com origem SP, destino BA, ao invés de RS como origem.
Exemplo de envio:
{
"remetente": {
"cnpj": ""
},
"expedidor": {
"cnpj": "",
"endereco": {
"cep": ""
}
},
"destinatario": {
"tipo_pessoa": 2,
"cnpj_cpf": "",
"inscricao_estadual": "",
"endereco": {
"cep": ""
}
},
"volumes": [
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0,
"consolidar": false,
"sobreposto": false,
"tombar": false
},
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0,
"consolidar": false,
"sobreposto": false,
"tombar": false
}
],
"filtro": 0,
"canal": "",
"limite": 0,
"codigo_plataforma": "",
"cotacao_plataforma": 0,
"token": "",
"retornar_consolidacao": true
}
Resposta:
- Se a requisição obtiver sucesso, será retornado o código de resposta HTTP 200 com as ofertas que atendem a rota, conforme os dados e exemplo abaixo.
| Descrição | Formato / Exemplo | Retornado | |
|---|---|---|---|
| token_oferta | Token único de identificação do cálculo de valores da cotação. Utilizado para contratação da oferta no método “Contratação”. | String | Sempre |
| transportadoras | Objeto com as ofertas das transportadoras | Objeto em json | Sempre |
| oferta | Código de identificação da oferta. Utilizada na contratação da oferta. | Numérico (inteiro) | Sempre |
| cnpj | CNPJ da transportadora | String numérica com 14 caracteres e sem formatação | Sempre |
| logotipo | URL de caminho do logotipo da transportadora | String | Sempre |
| nome | Nome fantasia da transportadora | String | Sempre |
| servico | Nome de serviço | String | Sempre |
| descricao_servico | Descrição do serviço | String | Eventualmente |
| prazo_entrega | Quantidade de dias úteis de previsão de entrega | Numérico (inteiro) | Sempre |
| entrega_estimada¹ | Data estimada de entrega pela transportadora, desconsiderando finais de semana, feriados nacionais do BRA e feriados calculados com a Páscoa ¹ | Date ("YYYY-MM-DD") | Sempre |
| validade | Data de validade da oferta da transportadora | Date ("YYYY-MM-DD") | Sempre |
| custo_frete | Custo real do frete calculado. Valor que deverá ser pago à transportadora. | Numérico (float) | Sempre |
| preco_frete | Preço do frete que deverá ser apresentando ao cliente da loja. Obs.: Poderá ser diferente do custo_frete caso haja regra de frete aplicada |
Numérico (float) | Sempre |
| volumes | Array com um ou mais objetos dos volumes informados ou consolidados | Array em json | retornar_consolidacao = true |
| tipo | Tipo do volume (vide tabela de tipos de volumes) | Numérico (inteiro) | Sempre |
| sku | SKU do volume | String | Eventualmente |
| tag | TAG do volume | String | Eventualmente |
| descricao | Descrição do volume | String | Eventualmente |
| quantidade | Quantidade de volumes/produtos iguais e do mesmo tipo | Numérico (inteiro) | Sempre |
| altura | Altura em Metros do volume | Numérico (float) | Sempre |
| largura | Largura em Metros do volume | Numérico (float) | Sempre |
| comprimento | Comprimento em Metros do volume | Numérico (float) | Sempre |
| peso | Peso total (em Kg) da quantidade de volumes informados | Numérico (float) | Sempre |
| valor | Valor total da quantidade de volumes informados | Numérico (float) | Sempre |
| volumes_produto | Quantidade de volumes do produto ao qual este volume pertence | Numérico (inteiro) | Eventualmente |
| itens | Array com um ou mais objetos pertencentes ao volume consolidado | Array em json | Eventualmente |
| tipo | Tipo do volume (vide tabela de tipos de volumes) | Numérico (inteiro) | Sempre |
| sku | SKU do volume | String | Eventualmente |
| tag | TAG do volume | String | Eventualmente |
| descricao | Descrição do volume | String | Eventualmente |
| quantidade | Quantidade de volumes/produtos iguais e do mesmo tipo | Numérico (inteiro) | Sempre |
| altura | Altura em Metros do volume | Numérico (float) | Sempre |
| largura | Largura em Metros do volume | Numérico (float) | Sempre |
| comprimento | Comprimento em Metros do volume | Numérico (float) | Sempre |
| peso | Peso total (em Kg) da quantidade de volumes informados | Numérico (float) | Sempre |
| valor | Valor total da quantidade de volumes informados | Numérico (float) | Sempre |
| volumes_produto | Quantidade de volumes do produto ao qual este volume pertence | Numérico (inteiro) | Eventualmente |
¹ A data estimada de entrega é uma previsão aproximada da entrega pela transportadora desconsiderando finais de semana ou feriados nacionais. Destacamos que o prazo efetivo para entrega é considerado por cada transportadora a partir da coleta das mercadorias. Para cálculo da data estimada de entrega não são considerados feriados municipais ou religiosos de cada região.
Observação: Após a cotação é possível gerar uma Solicitação de Coleta do frete calculado. Basta utilizar o método de Contratação.
Exemplo de resposta:
{
"token_oferta": "",
"transportadoras": [
{
"oferta": 1,
"cnpj": "",
"logotipo": "",
"nome": "",
"servico": "",
"descricao_servico": "",
"prazo_entrega": 1,
"entrega_estimada": "",
"validade": "",
"custo_frete": 0.0,
"preco_frete": 0.0
},
{
"oferta": 2,
"cnpj": "",
"logotipo": "",
"nome": "",
"servico": "",
"descricao_servico": "",
"prazo_entrega": 0,
"entrega_estimada": "",
"validade": "",
"custo_frete": 0.0,
"preco_frete": 0.0
},
{
"oferta": 3,
"cnpj": "",
"logotipo": "",
"nome": "",
"servico": "",
"prazo_entrega": 0,
"entrega_estimada": "",
"validade": "",
"custo_frete": 0.0,
"preco_frete": 0.0
}
],
"volumes":[
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.0,
"volumes_produto": 0
},
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0
},
{
"tipo": 0,
"sku": null,
"tag": null,
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0,
"itens" :[
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0
},
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0
},
{
"tipo": 0,
"sku": "",
"tag": "",
"descricao": "",
"quantidade": 0,
"altura": 0.00,
"largura": 0.00,
"comprimento": 0.00,
"peso": 0.00,
"valor": 0.00,
"volumes_produto": 0
}
]
}
]
}
Erros:
- Em caso de erro, será retornado um código de erro, conforme estabelecido na lista de códigos desta API.