FreteBarato
Nota Fiscal

Edição

Altere os dados de transporte, destino e totais de uma nota fiscal na API Frete Barato.

O endpoint de edit altera destino, totais, volumes, pesos e transportadora de uma nota fiscal.

CNPJ, volume, peso e nome da transportadora podem entrar no cadastro do pedido. Quando esses dados mudarem depois, use este endpoint.

A edição grava os 16 campos de uma vez. Os campos obrigatórios precisam vir no payload e um campo opcional omitido é gravado vazio. Por isso, consulte a nota, altere o que precisar e reenvie todos os campos.
Endpoint
https://admin.fretebarato.com/invoice/edit/v1/json/{{customer_id}}

Edite uma nota fiscal

curl -X PATCH "https://admin.fretebarato.com/invoice/edit/v1/json/{{customer_id}}" \
  -H "Authorization: Bearer xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "User-Agent: MinhaAplicacao ([email protected])" \
  -d '{
    "id_fatura_nota_fiscal": 987654,
    "emitente_cnpj": "12345678000199",
    "info": {
      "total_nf": 150.5,
      "total_frete": 10,
      "transporte_volume_quantidade": 3,
      "transporte_volume_peso_bruto": 2.5,
      "transporte_volume_peso_liquido": 2.2,
      "transporte_cnpj": "11222333000181",
      "transporte_nome": "Transportadora Exemplo Ltda",
      "transporte_nome_alias": "Exemplo",
      "destino_endereco_cep": "01310100",
      "destino_endereco_uf": "SP",
      "destino_endereco_bairro": "Bela Vista",
      "destino_endereco_logradouro": "Avenida Paulista",
      "destino_endereco_numero": "1000",
      "destino_endereco_complemento": "Sala 12",
      "destino_nome": "Maria Silva",
      "destino_endereco_telefone": "(11) 98765-4321"
    }
  }'

Headers

KeyValue
AuthorizationBearer {{token}}
Content-Typeapplication/json
User-AgentAplicação (e-mail para contato técnico)

Parâmetros do payload

ParâmetroTipoObrigatórioObservação
id_fatura_nota_fiscalNuméricoSimIdentificador da nota
emitente_cnpjStringSimCNPJ do emitente da nota, com 14 dígitos (aceita pontuação). Precisa ser um CNPJ cadastrado na conta
id_clienteNuméricoNãoSe enviado, precisa ser o da conta autenticada
infoObjectRecomendadoObjeto com os 16 campos da nota. Sem info, os campos são lidos da raiz do payload

Detalhe do objeto info

ParâmetroTipoObrigatórioObservação
total_nfNuméricoSimValor total da nota, maior ou igual a zero
total_freteNuméricoSimValor do frete, maior ou igual a zero
transporte_volume_quantidadeNuméricoSimQuantidade de volumes. Número inteiro a partir de 1
transporte_volume_peso_brutoFloatSimPeso bruto a partir de 0.001
transporte_volume_peso_liquidoFloatNãoPeso líquido a partir de 0.001. Omitido, null ou "" grava 0. O valor 0 é rejeitado
transporte_cnpjStringSimCNPJ da transportadora com exatamente 14 dígitos, sem pontuação
transporte_nomeStringSimNome da transportadora, de 3 a 200 caracteres
transporte_nome_aliasStringNãoNome alternativo da transportadora, até 200 caracteres. Vazio grava sem alias
destino_endereco_cepStringSimCEP com exatamente 8 dígitos, sem hífen
destino_endereco_ufStringSimUF com 2 caracteres. Gravada em maiúsculas
destino_endereco_bairroStringSimBairro, de 2 a 100 caracteres
destino_endereco_logradouroStringSimLogradouro, de 3 a 200 caracteres
destino_endereco_numeroStringSimNúmero do endereço, de 1 a 11 caracteres
destino_endereco_complementoStringNãoComplemento, até 200 caracteres
destino_nomeStringSimNome do destinatário, de 3 a 100 caracteres
destino_endereco_telefoneStringNãoTelefone com 10 ou 11 dígitos. Espaços, hífens e parênteses são removidos
A troca de CNPJ com o pedido em Transporte ou Entregue responde 400Não é permitido alterar o CNPJ da transportadora com o pedido em Transporte ou Entregue. Se a troca de CNPJ remover volumes já gerados, o pedido volta para faturado. A consulta indica esses casos em can_update_order e can_delete_volumes.

Parâmetros do response

ParâmetroTipoComportamento
successBooleanIndica se a requisição foi processada com sucesso (true/false)
codeNuméricoRetorna o código HTTP da resposta
messageStringMensagem descritiva sobre o resultado da edição
data.changedArrayLista dos campos alterados, com field (campo), from (valor anterior) e to (valor novo), sempre como texto. Um reenvio sem mudanças retorna []

Trate os erros

Os erros de validação dos campos de info retornam juntos na mesma resposta, no formato campo: mensagem. e separados por espaço (ex: transporte_cnpj: CNPJ deve ter 14 dígitos.).

ResponseTipoMensagemDescrição
400Bad RequestID da nota fiscal é obrigatório.id_fatura_nota_fiscal ausente, zero ou inválido
400Bad RequestCNPJ do emitente é obrigatório.emitente_cnpj ausente ou sem 14 dígitos
400Bad RequestNota fiscal inconsistente (emitente_cnpj).O emitente da nota é diferente do emitente_cnpj enviado
400Bad Requestcampo: mensagem.Um ou mais campos de info ausentes ou fora da regra (veja as mensagens abaixo)
400Bad RequestNão é permitido alterar o CNPJ da transportadora com o pedido em Transporte ou Entregue.Troca do CNPJ da transportadora com o pedido em transporte ou entregue
401UnauthorizedAuthentication failureFalha na autenticação: token inválido, Customer ID incorreto ou versão incorreta da API
403ForbiddenCliente inconsistente (id_cliente).id_cliente enviado diferente da conta autenticada
403ForbiddenVocê não tem permissão para acessar este recurso.O CNPJ do emitente não pertence à conta
404Not FoundCustomer not foundCustomer ID sem conta associada
404Not FoundCliente não encontrado.Cadastro da conta não localizado. Fale com o suporte
404Not FoundNota fiscal não encontrada.Não existe nota com esse identificador
406Not AcceptableInvalid Params (JSON)Payload ausente ou estrutura JSON inválida

Mensagens de validação do objeto info

ParâmetroMensagens
total_nfO campo Valor Total é obrigatório / O campo Valor Total não pode ser negativo.
total_freteO campo Valor Frete é obrigatório / O campo Valor Frete não pode ser negativo.
transporte_volume_quantidadeO campo Quantidade de Volumes é obrigatório / Quantidade de Volumes deve ser um número inteiro. / O campo Quantidade de Volumes não pode ser 0.
transporte_volume_peso_brutoO campo Peso Bruto é obrigatório / O campo Peso Bruto não pode ser 0.
transporte_volume_peso_liquidoO campo Peso Líquido não pode ser 0.
transporte_cnpjO campo CNPJ é obrigatório / CNPJ deve ter 14 dígitos.
transporte_nomeO campo Nome da Transportadora é obrigatório / Nome da Transportadora deve ter no mínimo 3 caracteres. / Nome da Transportadora deve ter no máximo 200 caracteres.
transporte_nome_aliasNome Alias deve ter no máximo 200 caracteres.
destino_endereco_cepO campo CEP é obrigatório / CEP deve ter 8 dígitos.
destino_endereco_ufO campo UF é obrigatório / UF deve ter 2 caracteres.
destino_endereco_bairroO campo Bairro é obrigatório / Bairro deve ter no mínimo 2 caracteres. / Bairro deve ter no máximo 100 caracteres.
destino_endereco_logradouroO campo Rua é obrigatório / Rua deve ter no mínimo 3 caracteres. / Rua deve ter no máximo 200 caracteres.
destino_endereco_numeroO campo Número é obrigatório / Número deve ter no mínimo 1 caractere. / Número deve ter no máximo 11 caracteres.
destino_endereco_complementoComplemento deve ter no máximo 200 caracteres.
destino_nomeO campo Nome é obrigatório / Nome deve ter no mínimo 3 caracteres. / Nome deve ter no máximo 100 caracteres.
destino_endereco_telefoneTelefone deve ter no mínimo 10 dígitos. / Telefone deve ter no máximo 11 dígitos.

Exemplos de erro

{
  "success": false,
  "code": 400,
  "message": "destino_endereco_uf: O campo UF é obrigatório. destino_endereco_bairro: O campo Bairro é obrigatório. destino_endereco_logradouro: O campo Rua é obrigatório. destino_endereco_numero: O campo Número é obrigatório. destino_nome: O campo Nome é obrigatório.",
  "data": null
}
Copyright © 2026