Skip to main content
PUT
O id da tarifa muda quando os valores são editados. Cada alteração de valores cria uma nova versão da tarifa, com id novo, e encerra a versão anterior. A resposta traz id (o novo) e id_anterior (o id que foi alterado; null quando não nasceu versão nova). Passe a usar o id devolvido: um PUT ou DELETE no id antigo responde 409 (tarifa encerrada). Alterar só horarios mantém o id.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Path Parameters

id
integer
required

Id da categoria. Deve pertencer à central autenticada.

tarifaId
integer
required

Id da tarifa. Deve ser uma tarifa vigente da categoria id.

Body

application/json
nome
string

Nome da tarifa (1 a 20 caracteres, sem <, >, ", ', &, \, emoji e quebra de linha). Omitido, mantém o valor atual.

Required string length: 1 - 20
metodo_calculo_tarifa
enum<string>

Método de cálculo: D duração, P hora parada, T tabelado, V km variável, B por bairro. Trocar o método exige os obrigatórios do método novo; os campos gravados que não se aplicam a ele são limpos.

Available options:
D,
P,
T,
V,
B
valor_bandeirada

Bandeirada. Métodos D, P e V (obrigatório). Omitido, mantém o valor atual.

Example:

"5.90"

valor_km

Valor por km. Métodos D e P (obrigatório). Omitido, mantém o valor atual.

Example:

"5.90"

valor_minuto

Valor por minuto. Métodos D e V (obrigatório). Omitido, mantém o valor atual.

Example:

"5.90"

valor_hora_parada

Valor da hora parada. Método P (obrigatório). Omitido, mantém o valor atual.

Example:

"5.90"

valor_minimo

Valor mínimo da corrida. Métodos D, P e V (obrigatório). Omitido, mantém o valor atual.

Example:

"5.90"

valor_parada_adicional

Valor por parada adicional. Métodos D, P, V e T. Omitido, mantém o valor atual.

Example:

"5.90"

valores_tabelados
object[]

Faixas de distância. Métodos T, V e B (obrigatório). Quando enviada, substitui a lista inteira. Omitido, mantém o valor atual.

Maximum array length: 101
habilitar_limite_distancia
boolean

Liga o limite de distância. Métodos D e V. false limpa limite_distancia_maxima. Omitido, mantém o valor atual.

limite_distancia_maxima

Distância máxima em km (maior que zero). Só com habilitar_limite_distancia: true; no V, maior que a maior faixa. Omitido, mantém o valor atual.

Example:

"5.90"

habilitar_taxa_deslocamento
boolean

Liga o bônus de deslocamento. false limpa os três campos do bônus. Omitido, mantém o valor atual.

taxa_deslocamento_valor_km

Bônus: valor por km (maior que zero). Só com habilitar_taxa_deslocamento: true. Omitido, mantém o valor atual.

Example:

"5.90"

taxa_deslocamento_km_minimo

Bônus: km mínimo (aceita zero). Só com habilitar_taxa_deslocamento: true. Omitido, mantém o valor atual.

Example:

"5.90"

taxa_deslocamento_valor_maximo

Bônus: valor máximo (maior que zero). Só com habilitar_taxa_deslocamento: true. Omitido, mantém o valor atual.

Example:

"5.90"

tipo_cobranca_retorno
enum<string>

Cobrança do retorno, só em bandeira que faz entregas: T pelo cálculo da tarifa, N não cobrar, F valor fixo, K por km percorrido, P porcentagem. Sem a funcionalidade de taxa de retorno, só T. Omitido, mantém o valor atual.

Available options:
T,
N,
F,
K,
P
valor_retorno_adicional

Valor do retorno (maior que zero). Só com tipo_cobranca_retorno F ou K. Omitido, mantém o valor atual.

Example:

"5.90"

taxa_retorno_porcentagem

Percentual do retorno (maior que zero, até 999.99). Só com tipo_cobranca_retorno P. Omitido, mantém o valor atual.

Example:

"5.90"

calcular_individual_por_entrega
boolean

Calcula o valor de cada entrega separadamente. Só em bandeira que faz entregas com o cálculo individual liberado, e método diferente de B. Omitido, mantém o valor atual.

horarios
object[] | null

Horários de atuação da tarifa extra. Quando enviada, substitui a lista inteira. A tarifa padrão não aceita horários, e a extra não aceita null. Omitido, mantém o valor atual. No máximo 36 horários quando a lista muda; reenviar a lista atual sem alteração é aceito mesmo acima disso (tarifa configurada no painel com mais blocos).

Maximum array length: 36

Response

Tarifa editada (ou sem alteração)

success
boolean
data
object

Tarifa com só os campos que se aplicam ao método e à operação da bandeira. Valores em texto com 2 casas decimais.