WS013 - Enviar Documentos para Comprovei

Objetivo

Esta integração tem por objetivo permitir o envio de um ou vários documentos para que sejam rastreados pela Comprovei©.

Descrição do método


`Método`	uploadDocuments
`Versão`	1
`WSDL principal`	https://soap.comprovei.com.br/importQueue/index.php?wsdl
`WSDL de contingencia`	https://soapcontingencia.comprovei.com.br/importQueue/index.php?wsdl
`XSD`	https://soap.comprovei.com.br/importQueue/schemas/MultiDocument.xsd

Importante

A conexão ao nosso serviço deve ser feito ao nosso servidor principal, porém sugerimos fortemente que também seja disponibilizada uma conexão ao nosso servidor de contingência, como garantia de disponibilidade dos nossos serviços. O servidor de contingência só é ligado em situações de indisponibilidade do nosso servidor principal. Tornar parametrizável a url de conexão também é uma boa prática;
Nossas conexões são seguras utilizando o protocolo SSL. Por questão de segurança nossos certificados são alterados constantemente e sem aviso prévio. Portanto é recomendável que não desenvolvam as integrações baseadas em um certificado fixo.
Constantemente (e sem aviso prévio) adicionamos novos campos e estruturas tanto nas requisições quanto nas respostas dos nossos webservices. Quem for utilizar nossos webservices deve implementar de tal maneira que os programas que consomem estes webservices não deixem de funcionar quando houver as alterações de campos mencionadas.

Características

As chamadas serão realizadas via SOAP sobre HTTPS;
A origem do chamado do Web Service será o sistema do cliente;

Importante

O usuário deste Web Service deve armazenar o protocolo gerado na resposta. Chamados de suporte referentes a esta integração irão necessitar deste protocolo.

Autenticação

As chamadas terão autenticação a nível de transporte (Basic Authentication);
Solicite o user / password ao administrador da conta.

Exemplo cabeçalho HTTP com a autenticação

POST https://soap.comprovei.com.br/importQueue/index.php HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "urn:WebServiceComprovei#uploadDocuments"
Authorization: Basic BASE64(user:password)
Content-Length: {quantidade de bytes enviados}
Host: soap.comprovei.com.br
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Request

A requisição para o nosso Web Service é composta da seguinte forma:

TAG	Tipo	Descrição
`conteudoArquivo`	string	Conteúdo do arquivo XML codificado em Base64. Ver seção 'Nosso XML de Documentos'.

Exemplo de Request

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:WebServiceComprovei">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:uploadDocuments soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <conteudoArquivo xsi:type="xsd:string">PERvY3VtZW50b3M+CiAgICA8RG9jdW1lbnRvPgogICAgICAgIDxUaXBvPk5GRTwvVGlwbz4KICAgICAgICA8VGlwb1BhcmFkYT5FPC9UaXBvUGFyYWRhPgogICAgICAgIDxNb2RlbG8+c3RyMTIzNDwvTW9kZWxvPgogICAgICAgIDxOdW1lcm8+c3RyMTIzNDwvTnVtZXJvPgogICAgICAgIDxWYWxvcj5zdHIxMjM0PC9WYWxvcj4KICAgICAgICA8U2VyaWU+c3RyMTIzNDwvU2VyaWU+CiAgICAgICAgPEVtaXNzYW8+MjAxOTAxMDc8L0VtaXNzYW8+CiAgICAgICAgPEF0dWFsaXphY2FvPjIwMTkwMTA3PC9BdHVhbGl6YWNhbz4KICAgICAgICA8Q2hhdmU+MzUxNTA0NjEwODczNjcwMDAyNjA1NTAwMTAwMTEyMDMxNjEwMDEyMzQ1Njc8L0NoYXZlPgogICAgICAgIDxjbnBqPjEyMzQ1Njc4OTAxMjM0PC9jbnBqPgogICAgICAgIDxjbnBqRW1pc3Nvcj4xMjM0NTY3ODkwMTIzNDwvY25wakVtaXNzb3I+CiAgICAgICAgPGNucGpUcmFuc3BvcnRhZG9yPjEyMzQ1Njc4OTAxMjM0PC9jbnBqVHJhbnNwb3J0YWRvcj4KICAgICAgICA8Y25wakNvbnNpZ25hdGFyaW8+MTIzNDU2Nzg5MDEyMzQKICAgICAgICA8L0NucGpDb25zaWduYXRhcmlvPgogICAgICAgIDxSb21hbmVpbz4xMjM0NTY8L1JvbWFuZWlvPgogICAgICAgIDxSZW1lc3NhPjY3ODkwMTIzPC9SZW1lc3NhPgogICAgICAgIDxQZWRpZG8+MTIzNDU8L1BlZGlkbz4KICAgICAgICA8UGxhY2E+QUFBMTIzNDwvUGxhY2E+CiAgICAgICAgPEZpbGlhbD5GaWxpYWxBc3NvY2lhZGFBb0RvYzwvRmlsaWFsPgogICAgICAgIDxQZXNvPjE8L1Blc28+CiAgICAgICAgPEN1YmFnZW0+MTA8L0N1YmFnZW0+CiAgICAgICAgPE9OVT5Db2RpZ288L09OVT4KICAgICAgICA8QWdlbmRhbWVudG8+MjAxOTAxMDc8L0FnZW5kYW1lbnRvPgogICAgICAgIDxQZXNvTGlxdWlkbz4xPC9QZXNvTGlxdWlkbz4KICAgICAgICA8Vm9sdW1lPjE8L1ZvbHVtZT4KICAgICAgICA8Um90YT4KICAgICAgICAgICAgPE5vbWU+MDQwMzY0NTQwMTwvTm9tZT4KICAgICAgICAgICAgPERhdGE+MjAxOTAxMDc8L0RhdGE+CiAgICAgICAgICAgIDxNb3RvcmlzdGE+MTIzNDU2Nzg5MDE8L01vdG9yaXN0YT4KICAgICAgICA8L1JvdGE+CiAgICAgICAgPEphbmVsYT4KICAgICAgICAgICAgPERhdGFIb3JhSW5pPjIwMTkwMTA3IDEwMDA8L0RhdGFIb3JhSW5pPgogICAgICAgICAgICA8RGF0YUhvcmFGaW0+MjAxOTAxMDcgMTEwMDwvRGF0YUhvcmFGaW0+CiAgICAgICAgPC9KYW5lbGE+CiAgICAgICAgPFRpcG9NYXRlcmlhbD5UaXBvTWF0ZXJpYWxEb2N1bWVudG88L1RpcG9NYXRlcmlhbD4KICAgICAgICA8Rm9ybmVjaW1lbnRvPkNvZGlnb0Zvcm5lY2ltZW50b0RvY3VtZW50bzwvRm9ybmVjaW1lbnRvPgogICAgICAgIDxDbGllbnRlPgogICAgICAgICAgICA8Q29kaWdvPjEyMzQ1NDY8L0NvZGlnbz4KICAgICAgICAgICAgPGNvZGlnb2ludGVybm8+QjEyMzQ1NUE8L2NvZGlnb2ludGVybm8+CiAgICAgICAgICAgIDxDb250YXRvPkNvbnRhdG9Eb0NsaWVudGU8L0NvbnRhdG8+CiAgICAgICAgICAgIDxUZWxlZm9uZT4wWFgxMjM0NTY3ODk8L1RlbGVmb25lPgogICAgICAgICAgICA8RW1haWw+ZW1haWxkb2NsaWVudGVAZG9taW5pby5jb20uYnI8L0VtYWlsPgogICAgICAgICAgICA8UmF6YW8+UmF6YW9Eb0NsaWVudGU8L1JhemFvPgogICAgICAgICAgICA8RW5kZXJlY28+RW5kZXJlY29Eb0NsaWVudGUsIE51bWVyb0RvQ2xpZW50ZTwvRW5kZXJlY28+CiAgICAgICAgICAgIDxCYWlycm8+QmFpcnJvRG9DbGllbnRlPC9CYWlycm8+CiAgICAgICAgICAgIDxDaWRhZGU+Q2lkYWRlRG9DbGllbnRlPC9DaWRhZGU+CiAgICAgICAgICAgIDxFc3RhZG8+VUZEb0NsaWVudGU8L0VzdGFkbz4KICAgICAgICAgICAgPFBhaXM+QlI8L1BhaXM+CiAgICAgICAgICAgIDxDRVA+Q0VQRG9DbGllbnRlPC9DRVA+CiAgICAgICAgICAgIDxSZWdpYW8+UmVnaWFvRG9DbGllbnRlPC9SZWdpYW8+CiAgICAgICAgICAgIDxUaXBvQ2xpZW50ZT5zdHIxMjM0PC9UaXBvQ2xpZW50ZT4KICAgICAgICAgICAgPE1lbnNhZ2VtPk1lbnNhZ2VtUGFyYU9Nb3RvcmlzdGFTb2JyZU9DbGllbnRlPC9NZW5zYWdlbT4KICAgICAgICAgICAgPGdlcmVudGVjb2RpZ28+Q29kaWdvRG9HZXJlbnRlRGFDb250YTwvZ2VyZW50ZWNvZGlnbz4KICAgICAgICAgICAgPGdlcmVudGVub21lPk5vbWVEb0dlcmVudGVEYUNvbnRhPC9nZXJlbnRlbm9tZT4KICAgICAgICAgICAgPGdlcmVudGVlbWFpbD5FbWFpbERvR2VyZW50ZURhQ29udGE8L2dlcmVudGVlbWFpbD4KICAgICAgICAgICAgPGdlcmVudGVjZWx1bGFyPkNlbHVsYXJEb0dlcmVudGVEYUNvbnRhPC9nZXJlbnRlY2VsdWxhcj4KICAgICAgICAgICAgPHN1cGVydmlzb3Jjb2RpZ28+Q29kaWdvRG9TdXBlcnZpc29yRGFDb250YTwvc3VwZXJ2aXNvcmNvZGlnbz4KICAgICAgICAgICAgPHN1cGVydmlzb3Jub21lPk5vbWVEb1N1cGVydmlzb3JEYUNvbnRhPC9zdXBlcnZpc29ybm9tZT4KICAgICAgICAgICAgPHN1cGVydmlzb3JlbWFpbD5FbWFpbERvU3VwZXJ2aXNvckRhQ29udGE8L3N1cGVydmlzb3JlbWFpbD4KICAgICAgICAgICAgPHN1cGVydmlzb3JjZWx1bGFyPkNlbHVsYXJEb1N1cGVydmlzb3JEYUNvbnRhPC9zdXBlcnZpc29yY2VsdWxhcj4KICAgICAgICA8L0NsaWVudGU+CiAgICAgICAgPGRhbmZlcz4KICAgICAgICAgICAgPGRhbmZlIE51bURhbmZlPSIxMjM0NTY3ODkwIj4KICAgICAgICAgICAgICAgIDxTZXJpZURhbmZlPjE8L1NlcmllRGFuZmU+CiAgICAgICAgICAgICAgICA8Y2hhdmVkYW5mZT4zNTE1MDQ2MTA4NzM2NzAwMDI2MDU1MDAxMDAxMTIwMzE2MTAwMTIzNDU2NzwvY2hhdmVkYW5mZT4KICAgICAgICAgICAgICAgIDxkYXRhZW1pc3Nhb2RhbmZlPjIwMTkwMTA3PC9kYXRhZW1pc3Nhb2RhbmZlPgogICAgICAgICAgICA8L2RhbmZlPgogICAgICAgIDwvZGFuZmVzPgogICAgICAgIDxTS1VzPgogICAgICAgICAgICA8U0tVIGNvZGlnbz0iMDAwMDAyNSI+CiAgICAgICAgICAgICAgICA8UGVzb0JydXRvPjE8L1Blc29CcnV0bz4KICAgICAgICAgICAgICAgIDxQZXNvTGlxdWlkbz4xPC9QZXNvTGlxdWlkbz4KICAgICAgICAgICAgICAgIDxWb2x1bWVzPjE8L1ZvbHVtZXM+CiAgICAgICAgICAgICAgICA8RGVzY3JpY2FvPkRlc2NyaWNhb0RvUHJvZHV0bzwvRGVzY3JpY2FvPgogICAgICAgICAgICAgICAgPFFkZT4zNjwvUWRlPgogICAgICAgICAgICAgICAgPFVvbT5VTjwvVW9tPgogICAgICAgICAgICAgICAgPEJhcmNvZGU+MTExMTExMTE8L0JhcmNvZGU+CiAgICAgICAgICAgIDwvU0tVPgogICAgICAgIDwvU0tVcz4KICAgIDwvRG9jdW1lbnRvPgo8L0RvY3VtZW50b3M+</conteudoArquivo>
      </urn:uploadDocuments>
   </soapenv:Body>
</soapenv:Envelope>

Response

Nosso Web Service responde para você da seguinte forma:

TAG	Tipo	Descrição
`Code`	integer	Código de retorno (ver tabela de Códigos Gerais de Retorno).
`Status`	string	Mensagem de retorno (ver tabela de Códigos Gerais de Retorno).
`protocolo`	string	Protocolo para consultar a evolução do pedido de importação (Retornado somente em caso de sucesso).
`Notifications`	element	Elemento composto por elementos Notification, que podem conter mensagens de aviso ou erro sobre cada documento enviado.

Protocolo

Quando um arquivo é aceito no nosso sistema, um protocolo é gerado para que o processo de importação seja acompanhado. Isso pode ser feito utilizando o método WS501.

Notification

Elemento composto por elementos Error ou Warning.

TAG	Tipo	Descrição
`Error`	element	Contém o código de erro, a chave do documento e a mensagem para aquele documento.
`Warning`	element	Contém o código de aviso, a chave do documento e a mensagem para aquele documento.

Error / Warning

TAG	Tipo	Descrição
`Code`	integer	Código de retorno (ver tabela de Códigos de Retorno do Documento).
`Doc`	string	Chave de identificação deste documento.
`Mensagem`	string	Mensagem de retorno (ver tabela de Códigos de Retorno do Documento).

Exemplo de Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:uploadDocumentsResponse>
         <Code xsi:type="xsd:integer">3</Code>
         <Status xsi:type="xsd:string">Alguns documentos apresentaram erros. Estes não foram adicionados à fila de importação.</Status>
         <protocolo xsi:type="xsd:string">2017022258ade8611f302</protocolo>
         <Notifications xsi:type="ns1:Notifications">
            <Error SOAP-ENC:arrayType="ns1:Notification[6]" xsi:type="ns1:ArrayNotifications">
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">35170104692027001034550050029045471273826851</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">35170104692027001034550050029079271914086761</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">35170104692027001034550050029079411001805635</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">41170109078580000104550010000061221977415460</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
            </Error>
         </Notifications>
      </ns1:uploadDocumentsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Exemplo de Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:WebServiceComprovei" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
   <SOAP-ENV:Body>
      <ns1:uploadDocumentsResponse>
         <Code xsi:type="xsd:integer">3</Code>
         <Status xsi:type="xsd:string">Alguns documentos apresentaram erros. Estes não foram adicionados à fila de importação.</Status>
         <protocolo xsi:type="xsd:string">2017022258ade8611f302</protocolo>
         <Notifications xsi:type="ns1:Notifications">
            <Error SOAP-ENC:arrayType="ns1:Notification[6]" xsi:type="ns1:ArrayNotifications">
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">35170104692027001034550050029045471273826851</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">35170104692027001034550050029079271914086761</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">35170104692027001034550050029079411001805635</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
               <item xsi:type="ns1:Notification">
                  <Code xsi:type="xsd:integer">3</Code>
                  <Doc xsi:type="xsd:string">41170109078580000104550010000061221977415460</Doc>
                  <Mensagem xsi:type="xsd:string">Documento com esta chave já importado</Mensagem>
               </item>
            </Error>
         </Notifications>
      </ns1:uploadDocumentsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Códigos Gerais de Retorno

Código	Descrição
0	Todos os documentos adicionados à fila de importação!
1	Arquivo identificado como xml inválido ou corrompido.
3	Alguns documentos apresentaram erros. Estes não foram adicionados à fila de importação.
4	Todos os documentos apresentam erros e não foram adicionados à fila de importação.
999	Usuário não autenticado!

Códigos de Retorno do Documento

Código	Descrição
3	Documento com esta chave já importado.
8	Itens do documento estão sem código. Importação abortada.

Nosso XML de Documentos

Nosso XML para importar um ou mais documentos é composto pelas seguintes TAGs:

TAG	Tipo	Obrigatório	Descrição
`Documentos`	root	Sim	Raiz do xml e composto por um ou mais Documento.

Documento

Indicador de início da estrutura de um documento.

TAG	Tipo	Obrigatório	Descrição
`Tipo`	string	Sim	Tipo do documento (NFE, OS, CTE, etc). Não existe validação para esta informação e serve apenas para referência.
`TipoParada`	string	Sim	Tipo da parada enviada. Valores permitidos: - E (Entrega) - T (Transbordo). - C (Coleta). - CA (Coleta). - CA2 (Coleta). - CG (Coleta). - CO (Coleta). - CIE (Coleta). - R (Retorno).
`Modelo`	string	Não	Modelo fiscal do documento (verificar junto a SEFAZ os modelos disponíveis).
`Numero`	string	Sim	Número do documento. Somente números sem caracteres especiais ou espaços.
`Valor`	string	Não	Valor total do documento.
`Serie`	string	Sim	Série do documento (no caso de NFe). Se não tiver, enviar valor 0.
`Emissao`	string	Sim	Data de emissão do documento. Obrigatório o formato YYYYMMDD.
`Atualizacao`	string	Não	Data de atualização do documento. Obrigatório o formato YYYYMMDD.
`Chave`	string	Sim	Chave do documento. Normalmente é a chave do documento fiscal (barcode). Este campo é obrigatório e seu conteúdo deve ser único para documentos diferentes.
`cnpj`	string	Sim	CNPJ (ou CPF) do destinatário do documento. (somente números).
`cnpjEmissor`	string	Sim	CNPJ do emitente do documento e/ou do embarcador. (somente números).
`cnpjTransportador`	string	Sim	CNPJ do transportador. (somente números).
`cnpjConsignatario`	string	Não	CNPJ do consignatário. (somente números).
`Romaneio`	string	Não	Número do romaneio do documento.
`Remessa`	string	Não	Número da remessa do documento.
`Pedido`	string	Não	Número do pedido do documento.
`Placa`	string	Não	Placa do veículo associado ao documento.
`Filial`	string	Não	Filial associada ao documento.
`Peso`	string	Não	Peso bruto da carga do documento.
`Cubagem`	string	Não	Volume total da carga do documento.
`ONU`	string	Não	Código de periculosidade da carga do documento.
`Anotacao`	string	Não	Anotação sobre o documento.
`Agendamento`	string	Não	Data de agendamento do documento.
`PesoLiquido`	string	Não	Peso líquido da carga do documento.
`Volume`	string	Não	Quantidade de volumes do documento.
`Rota`	element	Não	Rota para adicionar o documento no momento em que este for importado.
`Janela`	element	Não	Janela de entrega.
`TipoMaterial`	string	Não	Tipo do material do documento.
`Fornecimento`	string	Não	Código de fornecimento do documento.
`TipoFrete`	string	Não	Tipo do frete contratado para o documento.
`Modal`	string	Não	Modal de transporte contratado para o documento.
`Sla`	element	Não	Sla do documento.
`InfosPedido`	element	Não	InfosPedido
`Transportadora`	element	Não	Transportadora
`Embracador`	element	Não	Embarcador
`CamposLivres`	element	Não	Estes campos não são replicados. CamposLivres
`Cliente`	element	Sim	Indicador de início da estrutura do Cliente. Um documento está associada a um único cliente.
`danfes`	element	Não	Elemento inicializador da estrutura que contêm que contêm informações sobre todas as danfes associadas ao documento.
`SKUs`	element	Sim	Elemento inicializador da estrutura que contêm informações sobre todos os SKUs do documento.
`Volumes`	element	Não	Elemento inicializador da estrutura que contêm informações sobre todos os Volumes do documento.
`Itinerario`	element	Não	Dados do Itinerario

Rota

Contêm informações sobre a rota para que o documento seja adicionado assim que importado.

TAG	Tipo	Obrigatório	Descrição
`Nome`	string	*	Nome
`Data`	string	*	Data da rota, no formato YYYYMMDD.
`Motorista`	string	*	Código do motorista responsável pela rota.

*

Caso seja desejado adicionar este documento em uma rota assim que importado, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

Janela

TAG	Tipo	Obrigatório	Descrição
`DataHoraIni`	string	*	Horário de início da janela de entrega/coleta, no formato YYYYMMDD HHMM.
`DataHoraFim`	string	*	Horário de fim da janela de entrega/coleta, no formato YYYYMMDD HHMM.

*

Caso seja desejado informar a janela de entrega do documento, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

Sla

TAG	Tipo	Obrigatório	Descrição
`DiasUteis`	integer	*	Quantidade de dias úteis que a transportadora tem para finalizar o documento.**
`DataSla`	string	*	Prazo que a transportadora tem para finalizar o documento. Formato: YYYYMMDD**

*

Caso queira informar o SLA do documento, a TAG DiasUteis ou DataSla passa a ser obrigatória.

**

Só é aceita uma das opções, ou seja, envie somente a DataSla ou DiasUteis

InfosPedido

TAG	Tipo	Obrigatório	Descrição
`PedidoInterno`	string	*	Número Interno do Pedido.
`PedidoCliente`	string	*	Número Enviado para o Cliente do Pedido
`DataPedido`	string	*	Data da rota, no formato YYYYMMDD.

Transportadora

TAG	Tipo	Obrigatório	Descrição
`cnpj`	string	*	Cnpj da transportadora.
`Nome`	string	*	Nome da transportadora.

*

Caso seja desejado adicionar este documento em uma rota assim que importado, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

Embarcador

TAG	Tipo	Obrigatório	Descrição
`cnpj`	string	*	Cnpj do embarcador.
`Nome`	string	*	Nome do embarcador.

*

Caso seja desejado adicionar este documento em uma rota assim que importado, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

CamposLivres

TAG	Tipo	Obrigatório	Descrição
`CampoLivre1`	string	Não	Campo Livre
`CampoLivre2`	string	Não	Campo Livre
`CampoLivre3`	string	Não	Campo Livre
`CampoLivre4`	string	Não	Campo Livre
`CampoLivre5`	string	Não	Campo Livre

Cliente

Indicador de início da estrutura do cliente. Um documento está associado a um único cliente.

TAG	Tipo	Obrigatório	Descrição
`Codigo`	string	Sim	Código do cliente (ou CNPJ). Esse código é estritamente numérico.
`codigointerno`	string	Não	Código interno ou alternativo do cliente.
`Contato`	string	Sim	Nome do contato do cliente destinatário.
`Telefone`	string	Sim	Celular (para envio de SMS) do contato do cliente destinatário. Enviar somente os números, no formato DDDNNNNNNNNN.
`Email`	string	Sim	Email (para envio de emails) do contato do cliente destinatário.
`Razao`	string	Sim	Razão social ou nome fantasia do cliente destinatário.
`Endereco`	string	Sim	Endereço de entrega do cliente destinatário. Somente rua e número, separado por vírgula (",").
`Bairro`	string	Sim	Bairro do cliente destinatário.
`Cidade`	string	Sim	Cidade do cliente destinatário.
`Estado`	string	Sim	Estado(UF) do cliente destinatário.
`Pais`	string	Sim	País do cliente destinatário, em alpha-2 (BR), alpha-3 (BRA) ou por extenso (Brasil). Veja a lista aqui.
`CEP`	string	Sim	CEP do endereço de entrega.
`Regiao`	string	Não	Região ou filial ou rota do endereço de entrega.
`TipoCliente`	string	Não	Campo livre para diferenciar, no sistema, se o cliente em questão é especial ou comum.
`Mensagem`	string	Não	Texto informativo para o motorista sobre o cliente. Ex.: Entregar no 2and. Sala 21.
`vendedorcodigo`	string	Não	Código do vendedor da conta.
`vendedornome`	string	Não	Nome do vendedor da conta.
`vendedoremail`	string	Não	Conta de email do vendedor da conta.
`vendedorcelular`	string	Não	Celular do vendedor da conta no formato DDDNNNNNNNNN.
`supervisorcodigo`	string	Não	Código do supervisor da conta.
`supervisornome`	string	Não	Nome do supervisor da conta.
`supervisoremail`	string	Não	Conta de email do supervisor da conta.
`supervisorcelular`	string	Não	Celular do supervisor da conta no formato DDDNNNNNNNNN.
`gerentecodigo`	string	Não	Código do gerente da conta.
`gerentenome`	string	Não	Nome do gerente da conta.
`gerenteemail`	string	Não	Conta de email do gerente da conta.
`gerentecelular`	string	Não	Celular do gerente da conta no formato DDDNNNNNNNNN.
`gerenteseniorcodigo`	string	Não	Código do gerente sênior da conta.
`gerenteseniornome`	string	Não	Nome do gerente sênior da conta.
`gerentesenioremail`	string	Não	Conta de email do gerente sênior da conta.
`gerenteseniorcelular`	string	Não	Celular do gerente sênior da conta no formato DDDNNNNNNNNN.
`CodigoIBGE`	string	Não	Código identificador do município.
`Posicao`	element	Não	Elemento para envio de posição do cliente.
`CodigoGrupo`	string	Não	Código do grupo.
`DescricaoGrupo`	string	Não	Descrição do grupo.
`CodigoTrajeto`	string	Não	Código do trajeto.
`NomeTrajeto`	string	Não	Nome do trajeto.

Posição do Cliente

Elemento para o envio da localização do cliente.

TAG	Tipo	Obrigatório	Descrição
`Latitude`	decimal	*	Latitude do cliente, em decimal. Ex.: -23.5489
`Longitude`	decimal	*	Longitude do cliente, em decimal. Ex.: -46.6388

*

Caso seja desejado informar a posição de um cliente, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

Danfes

Elemento responsável por agrupar todos os elementos danfe do documento.

TAG	Tipo	Obrigatório	Descrição
`danfes`	elemento	Não	Indicador de início da estrutura das DANFEs associadas ao documento de entrega. Um documento pode ter mais de uma danfe.

Danfe

Contém informações sobre a DANFE do documento.

TAG	Tipo	Obrigatório	Descrição
`SerieDanfe`	string	*	Série da NF-e.
`chavedanfe`	string	*	Chave da NF-e.
`dataemissaodanfe`	string	*	Data de emissão desta NF-e, no formato AAAAMMDD.

Atributo	Tipo	Obrigatório	Descrição
`NumDanfe`	string	*	Atributo de Danfe. Corresponde ao número da NF-e.

*

Caso seja desejado informar a DANFE de um documento, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

SKUs

Elemento responsável por agrupar todas os elementos SKU.

TAG	Tipo	Obrigatório	Descrição
`SKU`	element	Sim	Contém informações sobre o item a ser entregue/coletados no cliente final. Um SKU pode ser um produto, um volume, um palete, etc.

SKU

Contém informações sobre o item a ser entregue/coletado.

TAG	Tipo	Obrigatório	Descrição
`PesoBruto`	string	Sim	Peso bruto total deste SKU.
`PesoLiquido`	string	Sim	Peso líquido total deste SKU.
`Volumes`	string	Sim	Quantidade total de volumes deste SKU.
`Descricao`	string	Sim	Descrição deste SKU.
`Qde`	string	Sim	Quantidade total deste SKU.
`Uom`	string	Sim	Unidade de medida deste SKU.
`Barcode`	string	Sim	Código de barras deste SKU (para conferência).
`Lote`	element	Não	Contém informações sobre o lote deste SKU.
`CodVolume`	string	Não	Código do volume para ser associado a este SKU, caso desejado.
`BU`	string	Não	Business Unit

Atributo	Tipo	Obrigatório	Descrição
`codigo`	string	Sim	Atributo de SKU. Corresponde ao código do SKU.

Lote

TAG	Tipo	Obrigatório	Descrição
`CodFabricante`	string	*	Código do fabricante do Lote.
`NomeFabricante`	string	*	Nome do fabricante do Lote.
`DataFabricacao`	string	*	Data de fabricação do Lote no formato: AAAA-MM-DD.
`DataValidade`	string	*	Data de validade do Lote no formato: AAAA-MM-DD.
`CodAnvisa`	string	*	Código ANVISA para o Lote, no formato: 13 digitos númericos, ISENTO ou vazio.

Atributo	Tipo	Obrigatório	Descrição
`codigo`	string	*	Atributo de Lote. Corresponde ao código do Lote.

*

Caso queira informar o Lote de um item, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

Volumes

Elemento responsável por agrupar todas os elementos Volume.

TAG	Tipo	Obrigatório	Descrição
`Volume`	element	Não	Contém informações sobre o volume do documento.

Volume

Contém informações sobre o volume do documento.

TAG	Tipo	Obrigatório	Descrição
`PesoBruto`	string	*	Peso bruto total deste volume.
`PesoLiquido`	string	*	Peso líquido total deste volume.
`Uom`	string	*	Descrição deste volume.
`Barcode`	string	*	Código de barras deste volume.

Atributo	Tipo	Obrigatório	Descrição
`codigo`	string	*	Atributo de Volume. Corresponde ao código do volume.

*

Caso queira informar o volume de um documento, todas as TAGs que compõem esse elemento passam a ser obrigatórias.

Itinerario

TAG	Tipo	Obrigatório	Descrição
`ChaveUnica`	string	*	Chave única do itinerário
`Codigo`	string	*	Código do itinerário
`Descricao`	string	*	Descricao do itinerário
`CodigoDeBarras`	string	*	Código de Barras do itinerário
`Data`	string	*	Data do itinerário
`Turno`	string	*	Turno do itinerário
`Prioridade`	string	*	Prioridade do itinerário
`Tipo`	string	*	Tipo do itinerário
`PontoTransbordo1`	string	*	Ponto de transbordo do itinerário
`CnpjTransportador1`	string	*	CNPJ do transportador do itinerário
`NomeTransportador1`	string	*	Nome do transportador do itinerário
`Filial`	string	*	Filial do itinerário

Estrutura completa de exemplo

Clique aqui para ver o exemplo

<?xml version="1.0" encoding="utf-8"?>
<Documentos>
  <Documento>
      <Tipo>NFE</Tipo>
      <TipoParada>E</TipoParada>
      <Modelo>str1234</Modelo>
      <Numero>str1234</Numero>
      <Valor>str1234</Valor>
      <Serie>str1234</Serie>
      <Emissao>20190107</Emissao>
      <Atualizacao>20190107</Atualizacao>
      <Chave>35150461087367000260550010011203161001234567</Chave>
      <cnpj>12345678901234</cnpj>
      <cnpjEmissor>12345678901234</cnpjEmissor>
      <cnpjTransportador>12345678901234</cnpjTransportador>
      <cnpjConsignatario>12345678901234</cnpjConsignatario>
      <Romaneio>123456</Romaneio>
      <Remessa>67890123</Remessa>
      <Pedido>12345</Pedido>
      <Placa>AAA1234</Placa>
      <Filial>FilialAssociadaAoDoc</Filial>
      <Peso>1</Peso>
      <Cubagem>10</Cubagem>
      <ONU>Codigo</ONU>
      <Agendamento>20190107</Agendamento>
      <PesoLiquido>1</PesoLiquido>
      <Volume>1</Volume>
      <Rota>
          <Nome>0403645401</Nome>
          <Data>20190107</Data>
          <Motorista>12345678901</Motorista>
      </Rota>
      <Janela>
          <DataHoraIni>20190107 1000</DataHoraIni>
          <DataHoraFim>20190107 1100</DataHoraFim>
      </Janela>
      <TipoMaterial>TipoMaterialDocumento</TipoMaterial>
      <Fornecimento>CodigoFornecimentoDocumento</Fornecimento>
      <TipoFrete>Expresso</TipoFrete>
      <Modal>Rodoviario</Modal>
      <Sla>
        <DiasUteis>0</DiasUteis>
      </Sla>
      <Cliente>
          <Codigo>1234546</Codigo>
          <codigointerno>B123455A</codigointerno>
          <Contato>ContatoDoCliente</Contato>
          <Telefone>0XX123456789</Telefone>
          <Email>emaildocliente@dominio.com.br</Email>
          <Razao>RazaoDoCliente</Razao>
          <Endereco>EnderecoDoCliente, NumeroDoCliente</Endereco>
          <Bairro>BairroDoCliente</Bairro>
          <Cidade>CidadeDoCliente</Cidade>
          <Estado>UFDoCliente</Estado>
          <Pais>BR</Pais>
          <CEP>CEPDoCliente</CEP>
          <Regiao>RegiaoDoCliente</Regiao>
          <TipoCliente>str1234</TipoCliente>
          <Mensagem>MensagemParaOMotoristaSobreOCliente</Mensagem>
          <supervisorcodigo>CodigoDoSupervisorDaConta</supervisorcodigo>
          <supervisornome>NomeDoSupervisorDaConta</supervisornome>
          <supervisoremail>EmailDoSupervisorDaConta</supervisoremail>
          <supervisorcelular>CelularDoSupervisorDaConta</supervisorcelular>
          <gerentecodigo>CodigoDoGerenteDaConta</gerentecodigo>
          <gerentenome>NomeDoGerenteDaConta</gerentenome>
          <gerenteemail>EmailDoGerenteDaConta</gerenteemail>
          <CodigoIBGE>12345678</CodigoIBGE>
      </Cliente>
      <danfes>
          <danfe NumDanfe="1234567890">
              <SerieDanfe>1</SerieDanfe>
              <chavedanfe>35150461087367000260550010011203161001234567</chavedanfe>
              <dataemissaodanfe>20190107</dataemissaodanfe>
          </danfe>
      </danfes>
      <SKUs>
          <SKU codigo="0000025">
              <PesoBruto>1</PesoBruto>
              <PesoLiquido>1</PesoLiquido>
              <Volumes>1</Volumes>
              <Descricao>DescricaoDoProduto</Descricao>
              <Qde>36</Qde>
              <Uom>UN</Uom>
              <Barcode>11111111</Barcode>
          </SKU>
      </SKUs>
  </Documento>
</Documentos>