Quais são os parâmetros da Freight API?

Conheça todos os parâmetros disponíveis na Freight API, com descrição e exemplos práticos.

Os parâmetros estão descritos separados pelos grupos ao qual eles pertencem.

Parâmetros Obrigatórios

• operationType - Array para indicar qual Tabela da Operação será considerada para o cálculo do frete. Valores permitidos: [A, B, C, D];

• goodsType - Array para indicar quais produtos serão transportados. Valores permitidos:

  • GRANEL_SOLIDO

  • GRANEL_LIQUIDO

  • FRIGORIFICADA_OU_AQUECIDA

  • CONTEINERIZADA

  • CARGA_GERAL

  • NEOGRANEL

  • PERIGOSA_GRANEL_SOLIDO

  • PERIGOSA_GRANEL_LIQUIDO

  • PERIGOSA_FRIGORIFICADA_OU_AQUECIDA

  • PERIGOSA_CONTEINERIZADA

  • PERIGOSA_CARGA_GERAL

  • GRANEL_PRESSURIZADA

• axis - Array para informar a quantidade de eixos. Valores permitidos: [2, 3, 4, 5, 6, 7, 9];

• distance - Número inteiro com a distância percorrida da rota (em km);

• date - Data no formato AAAA-MM-DD. O serviço utilizará as tabelas de frete vigentes conforme a data informada neste parâmetro. 

Parâmetros Opcionais

• roundTrip - Para indicar se o frete será calculado somente ida ou ida e volta. Valores permitidos:

  • true - A distância em km da rota será multiplicada por 2 para calcular o frete mínimo;

  • false - Valor padrão. O cálculo será realizado somente na ida;

• backEmpty - Para indicar se o veículo retornará vazio ou não. Valores permitidos:

  • true - O pagamento do retorno vazio obrigatório será calculado como sendo 92% (noventa e dois por cento) do valor do coeficiente de custo de deslocamento (CCD) da composição veicular utilizada multiplicado pela distância de retorno, conforme fixado em contrato.

  • false - Valor padrão. O cálculo será realizado normalmente.

• otherCosts - Array que permite incluir custos adicionais que serão somados aos demais custos da rota. Possuem os seguintes parâmetros:

  • name - Texto com o nome do custo.

  • type - Tipo do custo para aplicar porcentagem ou custo fixo sobre o valor do frete mínimo. Valores permitidos: [PERCENT, FIXED]

  • value - Número decimal a ser aplicado no cálculo do custo.