Criar uma viagem por Romaneio

A criação de uma viagem é o ponto central de toda a integração, consolidando todos os dados necessários para o processo logístico em um único fluxo.

Exemplo de requisição

• Método: POST
• URL: [URL_BASE]/api/Viagem/CriarViagem

Cabeçalhos

Content-Type: application/json
Authorization: Bearer {accessToken}

Corpo

{
    "viagemCriacao": {
        "cnpjEmissor": "string",
 "dataEmissaoViagem": "2023-10-04T13:37:39.230Z",
        "numeroViagem": "string",
        "cnpjTransportadora": "string",
        "nomeTransportadora": "string",
        "cpfMotorista": "string",
        "nomeMotorista": "string",
        "codigoVeiculo": "string",
        "placaVeiculo": "string",
        "qtdCarga": "string",
        "unidadeMedida": "string",
        "valorMercadoria": "string",
        "Tarefa": [
            {
                "tipoDocumento": 1,
                "tipoComprovação": 1,
                "numeroDocumento": "string",
                "chaveAcesso": "string",
                "serie": 5,
                "cnpjDestinatario": "string",
                "nomeDestinatario": "string",
                "sequenciamento": "string",
                "previsao": " string",
                "bairro": "string",
                "cep": "string",
                "logradouro": "string",
                "numero": "string",
                "municipio": "string",                 
                "uf": "ES"
            }
        ],
    }
}

Campo	Obrigatório?	Descrição
CNPJ Emissor	Sim	CNPJ da empresa emissora da viagem.
Data Emissão da Viagem	Sim	Data em que o documento está sendo emitido no formato: dd/mm/aaaa hh:ss.
Número da Viagem	Sim	Número de identificação da viagem, embarque, rota, etc.
CNPJ Transportadora	Não	CNPJ da empresa contratada para realizar o transporte.
Nome Transportadora	Não	Razão social da empresa contratada para realizar o transporte.
CPF Motorista	Sim	CPF do motorista responsável pela entrega utilizado para integração com o APP.
Nome Motorista	Sim	Nome do motorista responsável pela entrega.
Código do Veículo	Não	Identificador do tipo de veículo informado no MDF-e ou no cadastro (Configurações – ESG) pelo portal, para estimativa da emissão de Carbono (CO²).
Placa do Veículo	Não	Placa do veículo utilizado no transporte da mercadoria.
Quantidade da Carga	Não	Refere-se à quantidade de volume da carga.
Unidade Medida	Não	Refere-se ao peso da mercadoria (KGs, Lts, etc.).
Valor da Mercadoria	Não	Valor monetário da carga transportada.
Tarefas	Sim	Informações referentes às entregas e coletas que serão executadas na viagem.
Tipo Documento	Sim	Identificação do tipo de documento: 0 = CT-e, 1 = NF-e, 2 = Ordem de Coleta.
Tipo Comprovação	Não	Estabelece o fluxo de comprovação do aplicativo para uma entrega: “1” para foto do canhoto e “2” para assinatura na tela do dispositivo.
Número Documento	Sim	Número de identificação do documento.
Chave de Acesso	—	Sequência numérica única utilizada para identificar a NF-e ou o CT-e. (Preenchimento obrigatório quando o campo Tipo Documento for 1 ou 2).
Série Documento	—	Série de identificação quando o documento for NF-e ou CT-e. (Preenchimento obrigatório quando o campo Tipo Documento for 1 ou 2).
CNPJ / CPF Destinatário	Sim	CPF/CNPJ do destinatário da mercadoria.
Nome Destinatário	Sim	Identificação do destinatário.
Sequenciamento	Não	Campo para informar a sequência lógica em que o motorista deve confirmar suas entregas ou coletas.
Previsão	Não	Campo no formato data (dd/mm/aaaa) para indicar a previsão de entrega ou coleta de mercadoria.
Endereço Destino	Sim	Bairro, CEP, Logradouro, Número, Município e UF onde será realizada a entrega ou coleta.

Retorno do envio da viagem

Após o envio dos dados da viagem e suas tarefas, o NDD Move realiza o processamento das informações para validar e registrar o transporte.

Sucesso: Caso o status seja success, a viagem foi devidamente registrada e estará disponivel para visualização no portal web e no aplicativo do motorista. Erros: O status error indica que a viagem não foi registrada. Nesse caso, você deve corrigir os erros listados e reenviar os dados.

Boas Práticas

Dica

Validar os dados antes do envio: Utilize a documentação para garantir que todos os campos obrigatórios estejam preenchidos.

​