Contratação de Frete
POST https://freterapido.com/api/external/embarcador/v1/quote/ecommerce/[token_oferta]/offer/[oferta]?token=[seu_token]
Método que permite realizar a solicitação de frete, com base em uma cotação realizada.
Basta enviar uma requisição com os parâmetros estabelecidos abaixo.
Observações quanto ao expedidor:
- A validação dos dados listados como opcionais abaixo ainda pode acontecer se algum dos atributos opcionais for informado. Exemplo: Caso seja informada a rua do expedidor em questão, todos os demais dados além dos obrigatórios serão considerados como obrigatórios, com exceção ao complemento do endereço;
- Caso sejam informados apenas os dados obrigatórios, os dados complementares (fiscais e de endereço) serão obtidos através do cadastro de pontos de coleta na Frete Rápido;
Envio:
Parâmetros da URL:
Nome | Descrição | Formato / Exemplo | Obrigatório |
---|---|---|---|
token_oferta | Token identificador da simulação. Propriedade token_oferta no retorno do método Cotações de frete. Propriedade dispatchers[].id no retorno do método Cotações de frete v3. |
String de 24 caracteres | * |
oferta | Identificador da oferta. Propriedade transportadoras[].oferta no retorno do método Cotações de frete. Propriedade offers[].offer no retorno do método Cotações de frete v3. |
Numérico (inteiro) | * |
token | Token de integração | String de 32 caracteres | * |
*Obrigatório |
Parâmetros do corpo da requisição:
Descrição | Formato / Exemplo | Obrigatório | |
---|---|---|---|
remetente | Objeto com alguns dados do remetente/origem | Objeto em json | * |
cnpj | CNPJ do remetente | String Numérica de 14 caracteres sem formatação | * |
expedidor¹ | Objeto com dados de endereço do expedidor da carga | Objeto em json | Se houver expedidor |
cnpj | CNPJ do expedidor da carga | String Numérica de 14 caracteres sem formatação | Se houver expedidor |
razao_social | Razão social do expedidor | String | Opcional |
inscricao_estadual | Inscrição Estadual do expedidor da carga | String | Opcional |
endereco | Se houver expedidor | ||
cep | CEP do expedidor / origem da carga | String Numérica de 8 caracteres sem formatação | Se houver expedidor |
rua | Logradouro do expedidor | String | Opcional |
numero | Número do local do expedidor | String | Opcional |
bairro | Bairro do expedidor | String | Opcional |
complemento | Complemento do endereço (se houver) | String | Opcional |
destinatario | Objeto com dados de endereço do destinatário da carga | Objeto em json | * |
cnpj_cpf | CNPJ ou CPF do destinatário da carga | String Numérica de 11 ou 14 caracteres sem formatação | * |
inscricao_estadual | Inscrição Estadual do destinatário da carga | String | Se destinatário for Pessoa Jurídica |
nome | Nome ou Razão Social do destinatário | String de até 255 caracteres | * |
Endereço de e-mail do destinatário para casos de necessidade de contato por parte da transportadora | String | Se destinatário for Pessoa Jurídica | |
telefone | Telefone do destinatário para casos de necessidade de contato pela transportadora | String Numérica sem formatação | Opcional |
endereco | Endereço do destinatário | String | * |
cep | CEP do destinatário | String Numérica de 8 caracteres sem formatação | * |
rua | Logradouro do destinatário | String | * |
numero | Número do local do destinatário | String | * |
bairro | Bairro do destinatário | String | * |
complemento | Complemento do endereço (se houver) | String | Opcional |
cidade | Cidade do destinatário | String | Obrigatório se o CEP for inválido |
estado | Estado (UF) do destinatário | String | Obrigatório se o CEP for inválido |
metadados | Array de objetos contendo chave e valor com as informações adicionais da contratação | Array de objetos JSON contendo até 64 itens | Opcional |
chave | Nome do atributo de informação extra da solicitação de coleta, deve ser nome único para chave | String de até 255 caracteres | Se houver metadados |
valor | Corresponde ao valor do atributo da chave informada. | String de até 255 caracteres | Se houver metadados |
numero_pedido | Número do pedido na loja | String Numérica | Opcional |
data_pedido | Data de criação do pedido na loja | Datetime (YYYY-MM-DD HH:mm:ss) | Opcional |
data_faturamento | Data de faturamento do pedido na loja | Datetime (YYYY-MM-DD HH:mm:ss) | Opcional |
forma_pagamento | Forma de pagamento do pedido | String | Opcional |
obs_cliente | Observação(texto livre) do cliente sobre o pedido | String | Opcional |
valor_frete_cobrado | Valor do frete cobrado ao consumidor final | Numérico (float) | Opcional |
nota_fiscal | Array de objetos com os dados de Notas Fiscais | Array de objetos | Opcional |
numero | Número da nota fiscal | String Numérica | Se houver NF |
serie | Série da nota fiscal | String Numérica | Se houver NF |
cfop | Código Fiscal de Operações e Prestações da nota fiscal | String Numérica | Se houver NF |
quantidade_volumes | Quantidade de volumes da nota fiscal | String Numérica | Se houver NF |
chave_acesso | Chave de acesso da nota fiscal | String Numérica | Se houver NF |
valor | Valor da nota fiscal | Numérico (float) | Se houver NF |
valor_itens | Valor total dos itens da nota fiscal | Numérico (float) | Se houver NF |
data_emissao | Data da emissão da nota fiscal | Datetime ("YYYY-MM-DD hh:mm:ss") | Se houver NF |
tipo_operacao | Tipo de operação da nota fiscal | Numérico (inteiro) 0 = Entrada 1 = Saída |
Se houver NF |
tipo_emissao | Tipo de emissão da nota fiscal | Numérico (inteiro) 1 = Normal 2 = Contingência FS 3 = Contingência SCAN 4 = Contingência DPEC 5 = Contingência FS-DA |
Se houver NF |
protocolo_autorizacao | Protocolo de autorização da nota fiscal | String Numérica | Se houver NF |
data_coleta | Data de possível coleta informada pelo Embarcador. Atenção! Este poderá ser aceito ou recusado pela Transportadora. |
Date ("YYYY-MM-DD") | Opcional |
canal | Canal de venda | String | Opcional |
subcanal | Subcanal de venda | String | 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": "",
"razao_social": "",
"inscricao_estadual": "",
"endereco": {
"cep": "",
"rua": "",
"numero": "",
"bairro": "",
"complemento": ""
}
},
"destinatario": {
"cnpj_cpf": "",
"nome": "",
"email": "",
"telefone": "",
"endereco": {
"cep": "",
"rua": "",
"numero": "",
"bairro": "",
"complemento": "",
"cidade": "",
"estado": ""
}
},
"metadados": [
{
"chave": "",
"valor": ""
}
],
"numero_pedido": "",
"data_pedido": "",
"data_faturamento": "",
"forma_pagamento": "",
"obs_cliente": "",
"valor_frete_cobrado": 0.00,
"nota_fiscal": [
{
"numero": "",
"serie": "",
"cfop": "",
"quantidade_volumes": "",
"chave_acesso": "",
"valor": 0.00,
"valor_itens": 0.00,
"data_emissao": "",
"tipo_operacao": 0,
"tipo_emissao": 0,
"protocolo_autorizacao": ""
},
{
"numero": "",
"serie": "",
"cfop": "",
"quantidade_volumes": "",
"chave_acesso": "",
"valor": 0.00,
"valor_itens": 0.00,
"data_emissao": "",
"tipo_operacao": ,
"tipo_emissao": ,
"protocolo_autorizacao": ""
}
],
"data_coleta": "",
"canal": "",
"subcanal": ""
}
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.
Nome | Descrição | Formato / Exemplo | Retornado |
---|---|---|---|
id_frete | Identificador do frete contratado na Frete Rápido. Pode ser utilizado para rastrear o frete. | String de 13 caracteres | Sempre |
rastreio | URL de rastreio do frete pelo ID Frete Rápido. | String | Sempre |
{
"id_frete": "FR2112026BGG1",
"rastreio": "https://ondeestameupedido.com.br/FR2112026BGG1"
}
- Em caso de erro, será retornado um código de erro, conforme estabelecido na lista de códigos desta API.