Ir para o conteúdo

Verificação de Credenciais

POST https://freterapido.com/api/external/embarcador/v1/check-status

Permite verificar as credenciais de acesso junto à API Frete Rápido.

Envio:

Parâmetros do corpo da requisição:

Nome Descrição Formato / Exemplo Obrigatório
cnpj CNPJ que possui cadastro na Frete Rápido String de 14 caracteres sem formatação *
token Chave de acesso gerada no seu Painel Frete Rápido String de 32 caracteres *
codigo_plataforma Código único de sua plataforma. Solicite o seu código pelo canal suporte@freterapido.com String *

*Obrigatório

Exemplo de envio:

    {
      "cnpj": "",
      "token": "",
      "codigo_plataforma": ""
    }
Resposta:

  • Se a requisição obtiver sucesso, deve retornar o código de resposta HTTP 200 conforme exemplo abaixo.
Nome Descrição Formato / Exemplo Retornado
bloqueio Status de bloqueio Boolean: True para bloqueado e False para desbloqueado Sempre
saldo Quantidade de envios ainda disponível Numérico (inteiro) Sempre

Exemplo de resposta: 

    {
      "bloqueio": true,
      "saldo": 0
    }

Erros:

Voltar ao topo