APIs de Integração

O NDD Move utiliza, inicialmente, as seguintes APIs de integração:

Entregas CT-e

CODE

/api/Entregas/{chaveMDFe}/{chaveCTe}

Entregas NF-e

CODE

/api/NFes/Entrega/{chaveNFe}

Viagem

CODE

/api/Viagem
/api/Viagem/chave/{chaveMDFe}
/api/Viagem/numero/{numeroManifesto}

Importação de documentos XML e CSV

O NDD Move possui APIs para subir as viagens realizadas tanto por arquivos do tipo XML quanto CSV. Sendo assim, é possível fazer a criação e cancelamento dos documentos, bem como comprovar entregas por XML. As integrações são:

Criação de viagens em XML

MDF-e:

CODE

Post
/api/Recepcoes/MDFe

 

{
  "documento": "string"
}

CT-e:

CODE

Post 
/api/Recepcoes/CTe
{
  "documento": "string"
}

NF-e

CODE

Post 
/api/Recepcoes/NFe
{
  "documento": "string"
}

Criação de viagem em Json

CODE

"viagemCriacao": {

  "numeroViagem": "123",

  "dataEmissaoViagem": "2023-10-04T13:37:39.230Z",

  "cnpjEmissor": "06255692012888",

  "valorMercadoria": "3.700,41",

  "unidadeMedida": "KG",

  "qtdCarga": "1.661,014",

  "nomeMotorista": "Fulano de tal",

  "cpfMotorista": "13117088040",

  "codigoVeiculo":"01",
  "placaVeiculo": "OCQ2771",

    "entregas": [

    { 

     "tipoDocumentoEntrega": 1,
     "numeroDocumento": 999,

      "serie": 5,

      "chaveAcesso": "35230306255692012888570050000009991000007079",

      "previsao": " 25/07/2024",
      "sequenciamento": "1",
      "TipoComprovacao": "1",

      "nomeDestinatario": "EMPRESA LTDA",

      "cnpjDestinatario": "37599646000147",

      "logradouro": "BR 101",

      "numero": "1",

      "bairro": "JAQUEIRA",

      "municipio": "ANCHIETA",

      "cep": "29230000",

      "uf": "ES",

     }
  ]

}

Criação de viagens via CSV

CODE

Post
/api/Recepcoes/Csv
{
  "documento": "string"
}

Estrutura de integração para criação de viagens via CSV

Campo	Caracterez	Obrigatoriedade	Descritivo
Tipo Viagem	N 1	S	Código referente ao documento no qual a entrega está relacionada. MDF-e = 0, Manifesto ( Romaneio ) = 1
Número Viagem	N 5	S	Número de identificação da viagem, embarque, rota, etc.
Série Documento	N 3	N	Série de identificação do MDF-e. (Preenchimento quando o campo Tipo de documento for 0)
Emissão da viagem	A 16	S	Data em que o documento está sendo emitido no formato: dd/mm/aaaa hh:ss.
Chave Acesso	N 44	N	Sequência numérica única que é utilizada para identificar a MDF-e. (Preenchimento quando o campo Tipo de documento for 0)
CNPJ emissor	N 14	S	CNPJ da empresa emissora da viagem.
Valor da mercadoria	N	N	Valor monetário de cada entrega.
Unidade de medida	A	N	Refere-se ao peso da mercadoria.
Quantidade da carga	N	N	Refere-se a quantidade de volume da carga
Nome motorista	A	S	Nome do motorista responsável pela entrega.
CPF motorista	N 11	S	CPF do motorista responsável pela entrega utilizado para integração com o APP.
Código veículo	N 10	N	Identificador do tipo de veículo informado no MDF-e ou no cadastro ESG pelo portal, para estimativa da emissão de Carbono.
Placa do veículo	A 7	N	Placa do veículo utilizado no transporte da mercadoria.
Tipo Documento Entrega	A 15	S	Identificação se o documento é :
			1=NF-e
			2=CT-e
			3=Ordem de Coleta
Nº Documento	A 15	S	Número de identificação do documento.
Série	N 9	N	Série de identificação quando documento for por NF-e ou CT-e. (Preenchimento obrigatório quando o campo Tipo Documento for 1 ou 2).
Chave de acesso do documento	N 44	N	Sequência numérica única que é utilizada para identificar a NF-e ou o CT-e. (Preenchimento obrigatório quando o campo Tipo Documento for 1 ou 2).
Previsão	A 16	N	Campo no formato Data (dd/mm/aaaa) para indicar a previsão de entrega ou coleta de mercadoria.
Sequenciamento	N 100	N	Campo para informar a sequência lógica em que o motorista deve confirmar suas entregas ou coletas.
Tipo Comprovação	N 1	N	Estabelece o fluxo de comprovação do aplicativo para uma entrega: "1" para Foto do canhoto "2" para assinatura na tela do dispositivo
Nome Destinatário	A	S	Identificação do destinatário.
CNPJ/CPF Destinatário	N 14	S	CPF/CNPF do destinatário da mercadoria.
Logradouro	A	S
Número	N	S
Bairro	A	S
Município	A	S
CEP	N 9	S
UF	A 2	S

Cancelamentos de documentos via XML

MDF-e:

CODE

Post
/api/Recepcoes/CancelamentoMDFe
{
  "documento": "string"
}

CT-e:

CODE

Post
/api/Recepcoes/CancelamentoCTe
{
  "documento": "string"
}

NF-e:

CODE

Post 
/api/Recepcoes/CancelamentoNFe
{
  "documento": "string"
}

Comprovação de entrega via XML

CODE

Post
/api/Recepcoes/ComprovanteEntrega
{
  "documento": "string"
}

A forma de autenticação para uso das APIs deve ser feita após obter o token de autenticação.

API Para Recepção de Documentos

Acesse abaixo o Swagger da API do NDD Move.