Pular para o conteúdo principal

Criação do lote

Método e rota​

  • Criação (POST): /frete/lote/operacaoTransporte/{enterpriseID}

O payload é composto por um array de operações, contido na raiz loteOT. Cada item do array representa uma Operação de Transporte (OT) a ser processada.

observação

Cada item do array "loteOT” representa uma operação (OT) de transporte a ser processada. O payload permite o envio de múltiplas operações (de 1 a N) num único lote.

Corpo​

Consulte aqui as referências

Exemplo payload envolvendo pagamento de parcela
{
    "ide": {
        "tms": "nome tms ou sistema de origem",
        "cnpj": "12345678000199",
        "numero": "987654321",
        "serie": "1",
        "RNTRCContratante": "123456789",
        "tipoOperacao": 1,
        "emContigencia": false,
        "justificativaContingencia": "string",
        "ptEmissor": "EMISSOR_PADRAO",
        "dtInicio": "2026-05-05",
        "dtFim": "2026-06-04",
        "contrato": "CONTRATO_12345",
        "gerPgtoFin": 1,
        "altoDesempenho": false,
        "retornoVazio": false,
        "composicaoVeicular": false
    },
    "carga": {
        "codigoSH": 8703,
        "peso": 15000.5,
        "CodigoTipoCarga": 5,
        "ContratantesCargaFrac": [
            "cpf",
            "cnpj"
        ],
        "origem": {
            "codigoMunicipio": 3550308,
            "cep": "01001000",
            "latitude": -23.5505,
            "longitude": -46.633299999999998
        },
        "destino": {
            "codigoMunicipio": 3106200,
            "cep": "30130000",
            "latitude": -19.916699999999999,
            "longitude": -43.934600000000003
        },
        "distanciaPecorrida": 586.5,
        "documentosOriginarios": [
            {
                "tipo": "string",
                "numero": "string"
            }
        ]
    },
    "transp": {
        "rntrc": "123456789",
        "cpfCnpj": "98765432000199",
        "cadastro": {
            "nomeRazao": "TRANSPORTADORA EXEMPLO LTDA",
            "telefone": "11988887777",
            "email": "contato@transportadora.com",
            "tipo": 2,
            "inscEstadual": "123456789",
            "atividadePrincipal": "Carga e descarga",
            "formaConstituicao": "LTDA",
            "dataConstituicao": "2010-05-20",
            "endereco": {
                "UF": "SP",
                "cidade": "São Paulo",
                "bairro": "Centro",
                "logradouro": "Rua Exemplo",
                "numero": "100",
                "CEP": "01001000",
                "complemento": "Sala 101"
            }
        }
    },
    "veiculos": {
        "placa": "ABC1D23",
        "RNTRCTransportador": "123456789",
        "NumeroEixos": 3,
        "cadastro": {
            "modelo": "VOLVO FH 460",
            "kmLitroModelo": 2.5,
            "tipo": 1,
            "kmLitroVeiculo": 2.2999999999999998
        }
    },
    "valores": {
        "tipoPagamento": 1,
        "formaPagamento": 0,
        "vlrFrete": 3500.0,
        "tipoRateio": 3,
        "vlrCombustivel": 800.0,
        "vlrPedagio": 150.0,
        "parcelamento": {
            "regraERP": "string",
            "informacoes": {
                "parcelas": [
                    {
                        "nome": "string",
                        "tipoPgto": "1 - Manual",
                        "finalidadeParcela": "1 - Adiantamento",
                        "dataPrevisao": "string",
                        "valorAplicado": 0,
                        "valorReal": 0,
                        "descontos": [
                            {
                                "nmDesc": "string",
                                "vlrDesc": 0,
                                "dsDesc": "string"
                            }
                        ],
                        "transferenciaAutomatica": {
                            "cpfCondutor": "string",
                            "finalidadeParcela": "1 - Adiantamento"
                        }
                    }
                ]
            }
        },
        "tarifas": {
            "quantidadeTotal": 3,
            "valorTotal": 45.899999999999999
        },
        "dadosBancarios": {
            "tipoPagamento": 1,
            "codigoInstituicaoFinanceira": 1,
            "numeroAgencia": "1234",
            "numeroConta": "12345678",
            "digitoConta": "9"
        }
    },
    "adicionais": [
        {
            "nome": "string",
            "valor": "string"
        }
    ]
}
Exemplo payload somente emissão de CIOT
{
    "ide": {
		    "tms": "nome tms ou sistema de origem",
        "cnpj": "12345678000199",
        "numero": "987654321",
        "serie": "1",
        "RNTRCContratante": "123456789",
        "tipoOperacao": 1,
        "emContigencia": false,
        "justificativaContingencia": "string",
        "ptEmissor": "EMISSOR_PADRAO",
        "dtInicio": "2026-05-05",
        "dtFim": "2026-06-04",
        "contrato": "CONTRATO_12345",
        "gerPgtoFin": 1,
        "altoDesempenho": false,
        "retornoVazio": false,
        "composicaoVeicular": false
    },
    "carga": {
        "codigoSH": 8703,
        "peso": 15000.5,
        "CodigoTipoCarga": 5,
        "ContratantesCargaFrac": [
            "cpf",
            "cnpj"
        ],
        "origem": {
            "codigoMunicipio": 3550308,
            "cep": "01001000",
            "latitude": -23.5505,
            "longitude": -46.633299999999998
        },
        "destino": {
            "codigoMunicipio": 3106200,
            "cep": "30130000",
            "latitude": -19.916699999999999,
            "longitude": -43.934600000000003
        },
        "distanciaPecorrida": 586.5,
        "documentosOriginarios": [
            {
                "tipo": "string",
                "numero": "string"
            }
        ]
    },
    "transp": {
        "rntrc": "123456789",
        "cpfCnpj": "98765432000199",
        "cadastro": {
            "nomeRazao": "TRANSPORTADORA EXEMPLO LTDA",
            "telefone": "11988887777",
            "email": "contato@transportadora.com",
            "tipo": 2,
            "inscEstadual": "123456789",
            "atividadePrincipal": "Carga e descarga",
            "formaConstituicao": "LTDA",
            "dataConstituicao": "2010-05-20",
            "endereco": {
                "UF": "SP",
                "cidade": "São Paulo",
                "bairro": "Centro",
                "logradouro": "Rua Exemplo",
                "numero": "100",
                "CEP": "01001000",
                "complemento": "Sala 101"
            }
        }
    },
    "veiculos": {
        "placa": "ABC1D23",
        "RNTRCTransportador": "123456789",
        "NumeroEixos": 3,
        "cadastro": {
            "modelo": "VOLVO FH 460",
            "kmLitroModelo": 2.5,
            "tipo": 1,
            "kmLitroVeiculo": 2.2999999999999998
        }
    },
    "valores": {
        "tipoPagamento": 1,
        "formaPagamento": 0,
        "vlrFrete": 3500.0,
        "tipoRateio": 3,
        "vlrCombustivel": 800.0,
        "vlrPedagio": 150.0,
        "tarifas": {
            "quantidadeTotal": 3,
            "valorTotal": 45.899999999999999
        },
        "dadosBancarios": {
            "tipoPagamento": 1,
            "codigoInstituicaoFinanceira": 1,
            "numeroAgencia": "1234",
            "numeroConta": "12345678",
            "digitoConta": "9"
        }
    },
    "adicionais": [
        {
            "nome": "string",
            "valor": "string"
        }
    ]
}
Layout
Nome do CampoTipoTamanhoObrigatório?Observação
ideObject-Sim (1)Informações sobre a Operação de Transporte.
tmsString(20)20Sim(1)Informar nome do TMS ou sistema de origem
cnpj (em ide)String(14)14Sim (1)CNPJ da Contratante (14 dígitos).
RNTRCContratante9Sim (1)Tamanho: 9 caracteres
tipoOperacaonumber-Sim (1)1 - Operação Carga Lotação / 2 - Operação Carga Fracionada / 3 - Operação TAC-Agregado
numero (em ide)String(1–9)1–9Sim (1)Número da Operação de Transporte (pode ser interpretado também como number). uso interno
serie (em ide)String(1–4)1–4Sim (1)Série da Operação de Transporte. uso interno
indContigenciaboolean-Sim (1)true = contingência / false = fora da contingência
JutificativaContigenciaString250NãondContingencia = true → justificativa obrigatória (250 caracteres) / false → não permitida
ptEmissor (em ide)String(1–30)1–30Sim (1)Nome do ponto emissor (1–30). Configurado no portal nddCargo. uso interno
dtInicio (em ide)String10Não (0–1)Data de início (AAAA-MM-DD). Obrigatório para OT padrão e não deve ser informado para TAC-Agregado.
dtFim (em ide)String10Não (0–1)Data final (AAAA-MM-DD). Se não informado, +30 dias após dtInicio.
contrato (em ide)String(1–50)1–50Não (0–1)Identificação do contrato entre Contratante e Transportador. uso interno
gerPgtoFin (atributo de ide)number-Não (0–1)Indica movimentação financeira: 1= conta NDD; 2=Sem movimentação financeira/pagamento; 6=PIX/TED.
CargaObject-NãoInformações da carga. Obrigatório se TipoOperacao = 1 e 2
codigoSHnumber4Sim (1)Código do Sistema Harmonizado (4 dígitos). Obrigatório se TipoOperacao = 1 e 2
Pesonumber-NãoDeve ser maior que zero. Obrigatório se TipoOperacao = 1 e 2
CodigoTipoCarganumber-NãoTipos de carga (1 a 12). Obrigatório se TipoOperacao = 1 e 2
ContratantesCargaFracalfanumerico-NãoCPF E CNPJ. Obrigatório se TipoOperacao = 2
documentosOriginariosObject-Não (0–1)Dados dos documentos originários. uso interno
documentoOriginarioArray-Sim (1–N) se acimaCada objeto representa um documento (tipo e número).
tipo (em documentoOriginario)String(1–40)1–40Sim (1)Tipo do documento (ex.: NF-e, CT-e).
numero (em documentoOriginario)String(1–44)1–44Sim (1)Número ou código do doc.
transpObject-Sim (1)Dados sobre o transporte da carga. uso interno
rntrc (em transp)String(9)9Sim (1)RNTRC do transportador.
cpfCnpj (em transp)String(14)14Sim (1)CPF/CNPJ do transportador.
cadastro (em transp)Object-Sim (1)Dados do transportador
nomeRazao (em cadastro)String(150)150Sim (1)Nome/Razão social do Transportador.
telefone (em cadastro)String(11)11Sim (1)Telefone celular
email (em cadastro)String(255)255Não (0–1)E-mail do transportador.
tipo (em cadastro)number-Sim (1)1=TAC, 2=ETC, 3=CTC.
inscEstadual (em cadastro)String(14)?14Não (0)IE do ETC/CTC
atividadePrincipal (em cadastro)String-Não (0)Obrigatório p/ ETC ou CTC
formaConstituicao (em cadastro)String(5)5Não (0)Obrigatório p/ ETC ou CTC
dataConstituicao (em cadastro)String10Não (0)AAAA-MM-DD
endereco (em cadastro)Object-Não (0–1)Endereço do Transportador
UF (em cadastro – endereco)String(2)2Sim (1)Sigla UF
cidade (em cadastro – endereco)String(100)100Sim (1)Nome da cidade
bairro (em cadastro – endereco)String(255)255Sim (1)Bairro
logradouro (em cadastro – end.)String(255)255Sim (1)Logradouro
numero (em cadastro – end.)String-Não (0–1)Número
CEP (em cadastro – end.)String(8)8Não (0–1)CEP
complemento (em cadastro – end.)String(255)255Não (0–1)Complemento
dadosPF (em cadastro)Object-Não (0–1)Dados obrigatórios se TAC (nome da mae, data nascimento, etc.). uso interno
nomeMae (em dadosPF)String(150)150Sim (1)Nome da mãe do transportador TAC.
nomePai (em dadosPF)String(150)150Não (0–1)Nome do pai do transportador TAC.
dataNascimento (em dadosPF)String10Sim (1)AAAA-MM-DD. Obrigatório se “identidade” informado.
identidade (em dadosPF)String(20)20Sim (1)RG do transportador TAC.
dadosPJ (em cadastro)Object-Não (0–1)Obrigatório se ETC/CTC. uso interno
nomeCompleto (em socio)String(150)150Sim (1)Nome completo do sócio ETC/CTC.
nomeMae (em socio)String(150)150Sim (1)Nome da mãe do sócio.
nomePai (em socio)String(150)150Não (0–1)Nome do pai do sócio.
dataNascimento (em socio)String10Sim (1)Data de nascimento.
cpf (em socio)String(11)11Sim (1)CPF do sócio (11 dígitos).
identidade (em socio)String(20)20Sim (1)RG do sócio.
telefone (em socio)String(10–11)10–11Sim (1)Telefone do sócio.
email (em socio)String(255)255Não (0–1)E-mail do sócio.
endereco (em socio)Object-Sim (1)Endereço do sócio.
UF (em endereco – socio)String(2)2Sim (1)Sigla da UF.
cidade (em endereco – socio)String(100)100Sim (1)Nome da cidade. Se for exterior, "EXTERIOR"
bairro (em endereco – socio)String(255)255Sim (1)Bairro (ou "EXTERIOR").
logradouro (em endereco – socio)String(255)255Sim (1)Logradouro (ou "EXTERIOR").
numero (em endereco – socio)String-Não (0–1)Número do endereço.
CEP (em endereco – socio)String(8)8Não (0–1)CEP do sócio (ou 0 se exterior).
complemento (em endereco – socio)String(255)255Não (0–1)Complemento.
condutoresObject-Não (0–1)Obrigatório se OT c/ movimentação financeira; opcional se sem. uso interno para pagamento de terceiros. Porém, a grande maioria dos campos são opcionais.
cpf (em condutor)String(11)11Sim (1)CPF do condutor.
nomeCompleto (em condutor)String(150)150Sim (1)Nome do condutor.
nomeMae (em condutor)String(150)150Não (0–1)Nome da mãe do condutor.
nomePai (em condutor)String(150)150Não (0–1)Nome do pai.
dataNascimento (em condutor)String10Não (0–1)AAAA-MM-DD.
identidade (em condutor)String(20)20Não (0–1)RG do condutor (sem máscara).
CNH (em condutor)String(15)15Não (0–1)CNH do condutor.
dataEmissaoCNH (em condutor)String10Não (0–1)AAAA-MM-DD.
dataRenovacaoCNH (em condutor)String10Não (0–1)AAAA-MM-DD.
telefone (em condutor)String-Não (0–1)Telefone do condutor (10 ou 11 díg.).
RNTRCTransportador (em condutor)String(9)9Não (0–1)Obrigatório se condutor tiver cartão vinculado.
cpfCnpjTransportador (em condutor)String(14)14Sim (1)CPF/CNPJ do transportador.
endereco (em condutor)Object-Não (0–1)Endereço do condutor.
UF (endereco – condutor)String(2)2Não (0–1)Sigla UF do condutor.
cidade (endereco – condutor)String(100)100Não (0–1)Nome do município do condutor.
bairro (endereco – condutor)String(255)255Não (0–1)Bairro do condutor.
logradouro (endereco – condutor)String(255)255Não (0–1)Logradouro do condutor.
numero (endereco – condutor)String-Não (0–1)Número do endereço.
CEP (endereco – condutor)String(8)8Não (0–1)CEP do condutor.
complemento (endereco – condutor)String(255)255Não (0–1)Complemento do endereço do condutor.
veiculosObject-Sim (1)Dados dos veículos de transporte.
placa (em veiculo)String(7)7Sim (1)Placa do veículo.
RNTRCTransportador (em veiculo)String(9)9Sim (1)RNTRC do transportador responsável pelo veículo, na ANTT.
NumeroEixosnumber-SimPara veículo automotor: 2 a 4 eixos. Implemento: 1 a 4.
cadastro (em veiculos)Object-Não (0–1)Dados do veículo (modelo, kmLitro, tipo...).
modelo (em cadastro)String(100)100Sim (1)Modelo do veículo.
kmLitroModelo (em cadastro)decimal2 dec.Não (0–1)KM por litro do modelo (2 dec.). uso interno, porém opcional
tipo (em cadastro – veiculos)number-Sim (1)1=Tração; 2=Reboque.
kmLitroVeiculo (em cadastro)decimal2 dec.Não (0–1)KM por litro do veículo (2 dec.). uso interno, porém opcional
OrigemDestinoAlfanumérico-NãoQuando dentro de um par OD for informado mais de um tipo, deve se utilizar sempre o mais específico: LatLong-> CEP-> Cidade. Obrigatório se TipoOperacao = 1 e TipoOperacao = 2
Origemobjeto-NãoObjeto vinculado ao item de origemDestino. Obrigatório se TipoOperacao = 1 e TipoOperacao = 2
CodigoMunicipionumber-NãoCódigo do município conforme tabela oficial adotada pelo sistema (tabela adotada: código IBGE).
CepObjeto-Nãoinformar somente número
Latitudefloat-nãoDeve ser informada em conjunto com longitudeOrigem, quando aplicável.
Longitudefloat-nãoDeve ser informada em conjunto com latitudeOrigem, quando aplicável.
destinoobjeto-nãoObjeto vinculado ao item de origemDestino. Obrigatório se TipoOperacao = 1 e TipoOperacao = 2
CodigoMunicipionumber7nãoCódigo do município conforme tabela oficial adotada pelo sistema. Tamanho 7
Cepalfanumérico-nãoinformar somente numeros
Latitudefloat-não
Longitudefloat-não
DistanciaPecorridanumber8não (0-1)Deve ser maior que zero. Medida em km. Obrigatório se TipoOperacao = 1 e TipoOperacao = 2 (fracionada ou lotação)
valoresObject-Sim (1)Dados dos valores da OT.
TipoPagamentonumber-Sim (1)1-IP (cartão pré-pago emitido por IP ou IF), 2-Conta Corrente, 3-Conta Poupança, 4-Conta Pagamento, 5-Outros, 6-Pix
vlrFretedecimal1–15,2Sim (1)Valor do frete (1–15,2).
despesasObject-Não (0–1)Dados das despesas. uso interno
vlrDespesas (em despesas)decimal1–15,2Sim (1)Valor total das despesas (1–15,2).
descricao (em despesas)String(1–2000)1–2000Sim (1)Descrição das despesas.
parcelamentoObject-Não (0–1)Dados do parcelamento da OT. uso interno
regraERP (em parcelamento)String(30)30Sim (1)Regra de parcelamento no ERP. Deverá ser informado ou informacoes.
informacoes (em parcelamento)Object-Sim (1)Caso regraERP não seja informado.
parcelas (em informacoes)Object-Sim (1)Grupo de parcelas.
nome (em parcela)String(50)50Sim (1)Nome da parcela (ex.: "Adiantamento").
tipoPgto (em parcela)number-Sim (1)1=Manual, 2=Automático, 3=Imediato.
finalidadeParcela (em parcela)number-Sim (1)1=Adiantamento, 2=Saldo.
dataPrevisao (em parcela)String19Sim (1)AAAA-MM-DD HH:MM:SS.
valorAplicado (em parcela)decimal1–12,2Sim (1)Valor aplicado (1–12,2).
valorReal (em parcela)decimal-Não (0–1)Valor real se diferente.
descontos (em parcela)Object-Não (0–1)Dados dos descontos dessa parcela.
nmDesc (em desconto)String(50)50Sim (1)Nome do desconto.
vlrDesc (em desconto)decimal1–15,2Sim (1)Valor do desconto retido (1–15,2).
dsDesc (em desconto)String(255)255Não (0–1)Informações adicionais do desconto.
transferenciaAutomaticaObject-Não (0–1)Dados p/ configuração de transferência automática p/ condutor. uso interno
cpfCondutor (em transfAuto)String(11)11Sim (1)CPF do condutor beneficiário (11 díg.).
retencoes (em parcela)Object-Sim (1)Retenções de IRRF, INSS, SEST/SENAT. uso interno
irrf (em retencoes)decimal1–15,2Sim (1)Mesmo que zero (1–15,2).
inss (em retencoes)decimal1–15,2Sim (1)Mesmo que zero (1–15,2).
sestsenat (em retencoes)decimal1–15,2Sim (1)Mesmo que zero (1–15,2).
tipoRateio (em valores)number-Sim (1)1=Primeira, 2=Última, 3=Todas, 4=Não reter, 5=Todas c/ proporção.
descontos (em valores)Object-Não (0–1)Descontos gerais da OT. uso interno
nmDesc (desconto – OT)String(50)50Sim (1)Nome do desconto.
vlrDesc (desconto – OT)decimal1–15,2Sim (1)Valor do desconto (1–15,2).
dsDesc (desconto – OT)String(255)255Não (0–1)Informações adicionais do desconto.
vlrCombustivel (em valores)decimal1–15,2Não (0–1)Valor do combustível (1–15,2).
vlrPedagio (em valores)decimal-Não (0–1)Valor do pedágio.
tarifas (em valores)Object-Sim (1)Dados das tarifas. uso interno
quantidadeTotal (em tarifas)number1–7Sim (1)Quantidade total de tarifas (1–7).
valorTotal (em tarifas)decimal1–10,2Sim (1)Valor total de tarifas (1–10,2).
dadosBancarios (em valores)Object-Não (0–1)Obrigatório p/ OT padrão ou TAC-Agregado quando gerPgtoFin=3,4,6. Opcional se gerPgtoFin=2.
tipoPagamento (em dadosBancarios)number-Não (0–1)1= TED, 2= PIX.
codigoInstituicaoFinanceira (em dadosBancarios)number-Sim (1)Obrigatório quando tipoPagamento = 1, 2, 3 ou 4. Ex.: 001=Banco do Brasil, 104=Caixa, etc.
numeroAgencia (em dadosBancarios)alfanumérico (10)10Não (0–1)Obrigatório quando tipoPagamento = 2, 3 ou 4.
numeroConta (em dadosBancarios)alfanumérico (20)20Não (0–1)Identificador do meio de pagamento utilizado.
digitoConta (em dadosBancarios)String-Não (0–1)Dígito da conta (0 no lugar de X).
chavePix (em dadosBancarios)alfanumérico (77)77Não (0–1)Obrigatório quando tipoPagamento = 6.
cpfCnpjFavorecido (em dbancarios)String-Não (0–1)CPF/CNPJ do favorecido.
tipoChave (em dadosBancarios)number-Não (0–1)1=Email; 2=CPF/CNPJ; 3=Telefone; 4=Aleatório; 5=Dados Bancários.
IndPagamentonumber-Sim0 = à vista / 1 = a prazo
InfIndicadoresOperacionaisObject-NãoObjeto que agrupa os indicadores operacionais. Obrigatório se TipoOperacao = 1
IndAltoDesempenhoBoleano-Nãotrue = operação de alto desempenho / false = padrão. Obrigatório se TipoOperacao = 1
IndRetornoVazioBoleano-Nãotrue = operação com retorno vazio / false = sem previsão de retorno vazio. Obrigatório se TipoOperacao = 1
ComposicaoVeicularBoleano-Nãotrue = é composição veicular / false = não é composição veicular. Obrigatório se TipoOperacao = 1
adicionais (em OT)Object-Não (0–1)Dados adicionais p/ impressão. uso interno
nome (em campo)String(255)255Sim (1)Nome do campo adicional. uso interno
valor (em campo)String(2000)2000Sim (1)Valor do campo adicional. uso interno

Observação: Todos os campos devem ser validados quanto à sua presença e formato (datas, números, strings, etc.).

Regras de negócio​

  1. O período compreendido entre a data de inicio e a data de término da operações de transporte não poderá exceder 90 dias. Salvo as operações de transporte do tipo TAC-Agregado. Validado pela NDD e ANTT
  2. A operação de transporte do tipo TAC-Agregado vincula o veículo do TAC ao contratante em caráter de exclusividade durante o prazo mínimo de 10 (dez) dias e no máximo de 30 (trinta) dias. Portanto, o veículo não poderá ser vinculado a operação de transporte de outro contratante dentro do intervalo de tempo mínimo. Validado pela ANTT
  3. O veículo não poderá ser vinculado a dois CIOTs no mesmo período de tempo. Validado pela ANTT
  4. Operação de transporte do tipo TAC-Agregado: será classificada na situação Pendente o CIOT cujo encerramento não tenha sido realizado no prazo previsto. Permanecendo CIOT em situação pendente por período superior a 30 dias o contratante ficará impedido de registrar novos CIOTs do tipo TAC-Agregado. Validado pela ANTT
  5. Validação de piso mínimo de frete: o valor do frete informado deve respeitar o piso mínimo ANTT
  • Caso contrário:
    • CIOT não é gerado
    • Operação é considerada inexistente Validado pela ANTT

Validações e regras de negócio​

Formato e obrigatoriedade:

Todos os campos obrigatórios devem ser validados quanto à sua presença e conformidade com os padrões estabelecidos (por exemplo, datas, CPF/CNPJ, CEP, RNTRC, etc.).

Cadastro integrado:

As seções internas de cadastro em transp, condutores e veiculos possibilitam o registro ou atualização dos respectivos cadastros automaticamente, integrando os dados transacionais aos cadastros de base.

Consistência dos dados:

  • Verificar a integridade dos vínculos entre os dados operacionais e os cadastros (por exemplo, RNTRC, CPF/CNPJ).
  • As informações financeiras (vlrFrete, parcelamento, descontos, tarifas, etc.) devem ser consistentes, sem valores negativos ou incoerentes.

Processamento assíncrono:

Ao receber o lote, a API processará as operações de maneira assíncrona. Um GUID será gerado para identificar o processamento do lote e poderá ser usado posteriormente para consultar os resultados.

Resposta do POST​

Após o envio do lote, a resposta será imediata e informará se o lote foi aceito para processamento, retornando um GUID para acompanhamento.

Exemplo de resposta de sucesso:

{
"sucesso": true,
"guid": "xxxxxxxxxxxxxxx",
"codigo": "000",
"mensagem": "Lote recebido para processamento."
}

Observação:

sucesso: indica se o lote foi aceito para processamento (true) ou rejeitado (false).

guid: identificador único do lote, utilizado para acompanhar o processamento.

codigo: código de retorno da operação.

mensagem: descrição do resultado da requisição ou mensagens informativas.


Exemplo de resposta de erro:

{
"sucesso": false,
"guid": "",
"codigo": "400",
"mensagem": "Erro na validação dos parâmetros do lote."
}

Observação:

Quando sucesso for false, o lote não foi aceito para processamento.

O campo guid pode não ser retornado em caso de erro na validação inicial.

codigo e mensagem descrevem o motivo do erro ocorrido.

Próximos passos​

Acesse a consulta do processamento do lote ou veja como cancelar uma operação de transporte.

Etiquetas:
Última atualização em