Solicitação de encerramento

Método e rota

• Solicitação (POST): /frete/lote/operacaoTransporte/encerrar/:enterpriseId

Corpo

O corpo da requisição deve ser um JSON contendo os dados de identificação do CIOT e dados complementares para o encerramento do mesmo.

Consulte aqui as referências

Exemplo:

{
  "Cnpj": "string",
  "Ciot": "string",
  "CiotCodVerificador": "string",
  "qtdeCarga": 0,
  "codigoSH": "string",
  "qtdeViagens": 0,
  "rotaERP": "string",
  "tipoCiot": "1 - Padrao",
  "viagens": [
    {
      "origem": {
        "codigoMunicipio": "string",
        "cep": "string"
      },
      "destino": {
        "codigoMunicipio": "string",
        "cep": "string"
      },
      "quantidadeCarga": 0,
      "quantidadeViagens": 0,
      "codigoSH": "string"
    }
  ]
}

Layout

Nome do campo	Tipo	Observação
cnpj	string	CNPJ da contratante responsável pela OT.
ciot	string	Número identificador do CIOT da operação de transporte.
ciotCodVerificador	string	Código verificador do CIOT.
qtdeCarga	number	Quantidade de carga transportada.
codigoSH	string	Código SH (Sistema Harmonizado) da carga.
qtdeViagens	integer	Quantidade de viagens associadas à operação.
rotaERP	string	Identificador da rota no ERP do integrador.
tipoCiot	integer	Tipo de CIOT. Valores permitidos: 1 = Padrão, 2 = TAC Agregado.
viagens	array	Lista de viagens associadas ao encerramento da OT.
└─ origem	object	Dados de origem da viagem.
└─ destino	object	Dados de destino da viagem.
└─ quantidadeCarga	number	Quantidade de carga referente à viagem.
└─ quantidadeViagens	integer	Quantidade de viagens vinculadas a este registro.
└─ codigoSH	string	Código SH da carga referente à viagem.

Observação

Os campos qtdeCarga, codigoSH e qtdeViagens podem ser enviados no nível principal da requisição ou dentro da lista viagens, dependendo do valor de tipoCiot.

tipoCiot	Envio da lista viagens	Comportamento
1 (Padrão)	Não enviada	A API utiliza os valores informados nos campos do nível principal (qtdeCarga, codigoSH, qtdeViagens).
1 (Padrão)	Enviada	A lista deve conter apenas um item, e os valores são obtidos desse item.
2 (TAC Agregado)	Enviada	A API utiliza os valores informados em cada item da lista viagens, incluindo os dados de origem e destino.
2 (TAC Agregado)	Não enviada	A API utiliza os valores informados nos campos do nível principal da requisição.

Resposta do POST

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

• O campo "sucesso" indica se o lote foi aceito (true) ou não (false).
• "guid" contém o identificador único para acompanhar o processamento do encerramento.
• Os campos "codigo" e "mensagem" podem servir para informações gerais ou mensagens de aviso, conforme a implementação.

Exemplo de resposta de sucesso:

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

Exemplo de resposta de erro:

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

---

Próximos passos

Acesse a consulta da solicitação de encerramento ou veja como alterar uma operação de transporte.

---