Pular para conteúdo

WS011 - Enviar Rota para Comprovei

Clique aqui para ver histórico de versões
Data de atualização Data de publicação do serviço Alterações
25/06/2021 25/06/2021 Criação da v3

Objetivo

Esta integração tem por objetivo permitir o envio de uma rota para que seja rastreada pela Comprovei©

Descrição do método
Método uploadRoute
Versão 2
WSDL principal https://soap.comprovei.com.br/importQueue/v3/index.php?wsdl
WSDL de contingência https://soapcontingencia.comprovei.com.br/importQueue/v2/index.php?wsdl
XSD https://soap.comprovei.com.br/importQueue/schemas/Planilha.xsd

Importante

  1. 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;
  2. 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.

Versão

Você está acessando a versão 3 do nosso sistema de integração. Caso deseje consultar a versão anterior, clique aqui.

Importante

Se desejar inserir novos documentos em uma rota já importada para o Comprovei, clique aqui.

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 mensagem (SOAP Header);
  • Solicite o usuario / senha ao administrador da conta.

Request

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

Dentro da TAG <Credenciais>:

TAG Tipo Descrição
Usuario string Usuario para autenticação.
Senha string Senha do usuário para autenticação

Body

Dentro da TAG <uploadRoute>:

TAG Tipo Descrição
Rotas root Raiz do xml é composto por Rota.
nomeArquivo string Nome do arquivo enviado, com a extensão. Exemplo: rota.xml.

Exemplo de Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <Credenciais xmlns="WebServiceComprovei">
            <Usuario>String</Usuario>
            <Senha>String</Senha>
        </Credenciais>
    </Header>
    <Body>
        <uploadRoute xmlns="WebServiceComprovei:uploadRoute">
            <Rotas xmlns="WebServiceComprovei:WS011">
                <Rota numero="String">
                    <rotadestino>String</rotadestino>
                    <rotanome>String</rotanome>
                    <Data>String</Data>
                    <Regiao>String</Regiao>
                    <Transportadora>
                        <Codigo>String</Codigo>
                        <Razao>String</Razao>
                    </Transportadora>
                    <Motorista>
                        <Usuario>String</Usuario>
                        <PlacaVeiculo>String</PlacaVeiculo>
                        <TipoVeiculo>String</TipoVeiculo>
                        <Nome>String</Nome>
                        <Telefone>String</Telefone>
                        <CNH>
                            <Numero>String</Numero>
                            <Vencimento>String</Vencimento>
                        </CNH>
                    </Motorista>
                    <Base>
                        <Origem codigo="String">
                            <Nome>String</Nome>
                            <Rua>String</Rua>
                            <Numero>Int</Numero>
                            <Complemento>String</Complemento>
                            <Bairro>String</Bairro>
                            <Cidade>String</Cidade>
                            <Estado>String</Estado>
                            <CEP>String</CEP>
                            <Pais>String</Pais>
                            <Contato>String</Contato>
                            <Email>String</Email>
                            <Telefone>String</Telefone>
                            <Cnpj>String</Cnpj>
                            <CnpjMatriz>String<CnpjMatriz>
                            <TipoMatriz>String ("courier" ou "shipper")<TipoMatriz>
                            <CodigoIBGE>String</CodigoIBGE>
                            <Posicao>String</Posição>
                        </Origem>
                        <Destino codigo="String">
                            <Nome>String</Nome>
                            <Rua>String</Rua>
                            <Numero>Int</Numero>
                            <Complemento>String</Complemento>
                            <Bairro>String</Bairro>
                            <Cidade>String</Cidade>
                            <Estado>String</Estado>
                            <CEP>String</CEP>
                            <Pais>String</Pais>
                            <Contato>String</Contato>
                            <Email>String</Email>
                            <Telefone>String</Telefone>
                            <Cnpj>String<Cnpj>
                            <CnpjMatriz>String<CnpjMatriz>
                            <TipoMatriz>String ("courier" ou "shipper")<TipoMatriz>
                            <CodigoIBGE>String</CodigoIBGE>
                            <Posicao>
                                <Latitude>String</Latitude>
                                <Longitude>String</Longitude>
                            </Posição>
                        </Destino>
                    </Base>
                    <limites>
                        <inicio>String</inicio>
                        <fim>String</fim>
                    </limites>
                    <TipoRota>String ("D", "T", "P" ou "R")</TipoRota>
                    <TipoMaterial>String</TipoMaterial>
                    <Fornecimento>String</Fornecimento>
                    <TipoFrete>String</TipoFrete>
                    <Modal>String</Modal>
                    <CamposLivres>
                        <CampoLivre1>String</CampoLivre1>
                        <CampoLivre2>String</CampoLivre2>
                        <CampoLivre3>String</CampoLivre3>
                        <CampoLivre4>String</CampoLivre4>
                        <CampoLivre5>String</CampoLivre5>
                    </CamposLivres>
                    <Paradas>
                        <Parada numero="Int">
                            <Tipo>String ("E", "T", "C", "CA", "CA2", "CG", "CO", "CIE" ou "R")</Tipo>
                            <Mensagem>String</Mensagem>
                            <Documento>
                                <Tipo>String</Tipo>
                                <Serie>String</Serie>
                                <Emissao>String</Emissao>
                                <Numero>String</Numero>
                                <ChaveNota>String</ChaveNota>
                                <ValorNota>String</ValorNota>
                                <ModeloDoc>String</ModeloDoc>
                                <Cnpj>String</Cnpj>
                                <CnpjEmissor>String</CnpjEmissor>
                                <CnpjTransportador>String</CnpjTransportador>
                                <CnpjConsignatario>String</CnpjConsignatario>
                                <Romaneio>String</Romaneio>
                                <Remessa>String</Remessa>
                                <Pedido>String</Pedido>
                                <Placa>String</Placa>
                                <Filial>String</Filial>
                                <Peso>String</Peso>
                                <Cubagem>String</Cubagem>
                                <ONU>String</ONU>
                                <Anotacao>String<Anotacao>
                                <Agendamento>String</Agendamento>
                                <PesoLiquido>String</PesoLiquido>
                                <Volume>String</Volume>
                                <Janela>
                                    <DataHoraIni>String</DataHoraIni>
                                    <DataHoraFim>String</DataHoraFim>
                                </Janela>
                                <TipoMaterial>String</TipoMaterial>
                                <Fornecimento>String</Fornecimento>
                                <TipoFrete>String</TipoFrete>
                                <Modal>String</Modal>
                                <Sla>
                                    <DiasUteis>Int</DiasUteis>
                                    <DataSla>String</DataSla>
                                </Sla>
                                <InfosPedido>
                                    <InfoPedido>
                                        <PedidoInterno>String</PedidoInterno>
                                        <PedidoCliente>String</PedidoCliente>
                                        <DataPedido>String</DataPedido>
                                    </InfoPedido>
                                    <InfoPedido>
                                        <PedidoInterno>String</PedidoInterno>
                                        <PedidoCliente>String</PedidoCliente>
                                        <DataPedido>String</DataPedido>
                                    </InfoPedido>
                                </InfosPedido>
                                <Embarcador>
                                    <cnpj>String</cnpj>
                                    <Nome>String</Nome>
                                </Embarcador>
                                <CamposLivres>
                                    <CampoLivre1>String</CampoLivre1>
                                    <CampoLivre2>String</CampoLivre2>
                                    <CampoLivre3>String</CampoLivre3>
                                    <CampoLivre4>String</CampoLivre1>
                                    <CampoLivre5>String</CampoLivre5>
                                </CamposLivres>
                                <Itinerario>
                                    <ChaveUnica>String</ChaveUnica>
                                    <Codigo>String</Codigo>
                                    <Descricao>String</Descricao>
                                    <CodigoDeBarras>String</CodigoDeBarras>
                                    <Data>String</Data>
                                    <Turno>String</Turno>
                                    <Prioridade>String</Prioridade>
                                    <Tipo>String</Tipo>
                                    <PontoTransbordo1>String<PontoTransbordo1>
                                    <CnpjTransportator1>String</CnpjTransportator1>
                                    <NomeTransportador1>String</NomeTransportador1>
                                    <Filial>String</Filial>
                                </Itinerario>
                            </Documento>
                            <Cliente>
                                <Codigo>String</Codigo>
                                <codigointerno>String</codigointerno>
                                <Contato>String</Contato>
                                <Telefone>String</Telefone>
                                <Email>String</Email>
                                <Razao>String</Razao>
                                <Endereco>String</Endereco>
                                <Bairro>String</Bairro>
                                <Cidade>String</Cidade>
                                <Estado>String</Estado>
                                <Pais>String</Pais>
                                <CEP>String</CEP>
                                <Regiao>String</Regiao>
                                <TipoCliente>String</TipoCliente>
                                <Mensagem>String</Mensagem>
                                <vendedorcodigo>String</vendedorcodigo>
                                <vendedornome>String</vendedornome>
                                <vendedoremail>String</vendedoremail>
                                <vendedorcelular>String</vendedorcelular>
                                <gerentecodigo>String</gerentecodigo>
                                <gerentenome>String</gerentenome>
                                <gerenteemail>String</gerenteemail>
                                <gerentecelular>String</gerentecelular>
                                <supervisorcodigo>String</supervisorcodigo>
                                <supervisornome>String</supervisornome>
                                <supervisoremail>String</supervisoremail>
                                <supervisorcelular>String</supervisorcelular>
                                <gerenteseniorcodigo>String</gerenteseniorcodigo>
                                <gerenteseniornome>String</gerenteseniornome>
                                <gerentesenioremail>String</gerentesenioremail>
                                <gerenteseniorcelular>String</gerenteseniorcelular>
                                <CodigoIBGE>String</CodigoIBGE>
                                <Posicao>
                                    <Latitude>Decimal</Latitude>
                                    <Longitude>Decimal</Longitude>
                                </Posicao>
                                <CodigoGrupo>String</CodigoGrupo>
                                <DescricaoGrupo>String</DescricaoGrupo>
                                <CodigoTrajeto>String<CodigoTrajeto>
                                <NomeTrajeto>String</NomeTrajeto>
                            </Cliente>
                            <danfes>
                                <danfe NumDanfe="String">
                                    <SerieDanfe>String</SerieDanfe>
                                    <chavedanfe>String</chavedanfe>
                                    <dataemissaodanfe>String</dataemissaodanfe>
                                </danfe>
                            </danfes>
                            <SKUs>
                                <SKU codigo="String">
                                    <PesoBruto>String</PesoBruto>
                                    <PesoLiquido>String</PesoLiquido>
                                    <Volumes>String</Volumes>
                                    <Descricao>String</Descricao>
                                    <Qde>String</Qde>
                                    <Uom>String</Uom>
                                    <Barcode>String</Barcode>
                                    <Lote codigo="String">
                                        <CodFabricante>String</CodFabricante>
                                        <NomeFabricante>String</NomeFabricante>
                                        <DataFabricacao>String</DataDabricacao>
                                        <DataValidade>String</DataValidade>
                                        <CodAnvisa>String</CodAnvisa>
                                    </Lote>
                                    <CodVolume>String</CodVolume>
                                    <BU>String</BU>
                                </SKU>
                            </SKUs>
                            <Volumes>
                                <Volume>
                                    <PesoBruto>String</PesoBruto>
                                    <PesoLiquido>String</PesoLiquido>
                                    <Uom>String</Uom>
                                    <Barcode>String</Barcode>
                                </Volume>
                            </Volumes>
                            <Sla>
                                <DiasUteis>Int</DiasUteis>
                                <DataSla>String</DataSla>
                            </Sla>
                            <ETA>
                                <ETAInicial>String</ETAInicial>
                                <TempoDePermanenciaPrevisto>Int</TempoDePermanenciaPrevisto>
                            </ETA>
                        </Parada>
                    </Paradas>
                </Rota>
            </Rotas>
            <nomeArquivo>rota.xml</nomeArquivo>
        </uploadRoute>
    </Body>
</Envelope>

Response

Nosso Web Service responde para você da seguinte forma:

TAG Tipo Descrição
status string Mensagem de sucesso ou de erro para a chamada do método.
protocolo string Protocolo para consultar a evolução do pedido de importação.

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.

Exemplo de Response

Sucesso

<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:uploadRouteResponse>
         <status xsi:type="xsd:string">Arquivo adicionado para a fila de importação!</status>
         <protocolo xsi:type="xsd:string">2017022258add9af06990</protocolo>
      </ns1:uploadRouteResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Nosso XML de Rota

Nosso XML para importar uma rota é composto pelas seguintes TAGs:

TAG Tipo Obrigatório Descrição
Rotas root Sim Raiz do xml e composto por Rota.

Rota

TAG Tipo Obrigatório Descrição
rotadestino string Não Indicação do destino ou roteiro da rota (limitado a 30 caracteres).
rotanome string Não Indicação do nome da rota.
Data string Sim Data de inicio da operação da rota. Obrigatório o formato AAAAMMDD.
Regiao string Não Região da rota.
Transportadora element Sim Elemento inicializador da estrutura que contêm informações sobre a Transportadora que executará a rota.
Motorista element Sim Elemento inicializador da estrutura que contêm informações sobre o Motorista que executará a rota.
Base element Não Elemento inicializador da estrutura que contêm informações sobre a Base de origem e destino da rota.
limites element Não Elemento inicializador da estrutura que contêm informações as datas e horários Limites de início e fim da rota.
TipoRota string Não Tipo da rota enviada. Valores permitidos:
- D (Distribuição)
- T (Transbordo)
- P (Praça)
- R (Retorno)
TipoMaterial string Não Tipo do material da rota.
Fornecimento string Não Código de fornecimento da rota.
TipoFrete string Não Tipo do frete contratado para a rota.
CamposLivres element Não Estes campos não são replicados. CamposLivres
Paradas element Sim Elemento inicializador da estrutura que contêm informações sobre todas as Paradas que serão feitas pelo motorista.
Atributo Tipo Obrigatório Descrição
numero string Sim Atributo de Rota. Corresponde ao número da rota no sistema.

Transportadora

Indicador de inicio da estrutura Transportadora. Uma rota pode conter uma única transportadora.

TAG Tipo Obrigatório Descrição
Codigo string Sim Código da transportadora. Normalmente é o CNPJ. Enviar somente números.
Razao string Sim  Nome da transportadora. Pode-se utilizar um nome curto (nome fantasia).

Caso não possua essas informações, os campos devem ser enviados sem conteúdo (vazios).

Motorista

Indicador de inicio da estrutura Motorista. Uma rota pode conter um único motorista.

TAG Tipo Obrigatório Descrição
Usuario string Sim Código do motorista cadastrado no Comprovei.
PlacaVeiculo string Sim Placa do veículo no formato: AAA9999 (sem traço ou espaço).
TipoVeiculo string Não Tipo do veículo que será utilizado na realização da rota.
Nome string Não Nome do motorista. Este campo será utilizado somente quando o cadastro automático do motorista for necessário!.
Telefone string Não Telefone do motorista, no formato DDDNNNNNNNNN. Este campo será utilizado somente quando o cadastro automático do motorista for necessário!.
CNH element Não CNH do motorista. Este elemento será utilizado somente quando o cadastro automático do motorista for necessário!.

Caso não possua essas informações, os campos devem ser enviados sem conteúdo (vazios) e a rota será associada a um motorista manualmente.

O elemento CNH é composto da seguinte forma:

TAG Tipo Obrigatório Descrição
Numero string * Número da CNH do motorista.
Vencimento string * Data de vencimento da CNH do motorista, no formato AAAAMMDD.

*

Os campos são obrigatórios caso queira informar a CNH do motorista.

Base

Indicador de inicio da estrutura das bases origem e destino. Essas informações são opcionais e devem ser necessariamente preenchidas nos casos de utilização da roteirização.

TAG Tipo Obrigatório Descrição
Origem element * Local de início da rota.
Destino element * Local de finalização da rota.

Origem e Destino são compostos da seguinte forma:

TAG Tipo Obrigatório Descrição
Nome string * Nome de cadastro da base.
Rua string *  Logradouro da base de origem (Rua, Avenida, Praça,etc).
Numero integer * Número da base.
Complemento string * Complemento do endereço da base.
Bairro string * Bairro da base.
Cidade string * Cidade da base.
Estado string * UF da base (Por exemplo: SP, MG).
CEP string * CEP (somente números, sem traço ou espaços) da base.
Pais string * País da base, em alpha-2 (BR), alpha-3 (BRA) ou por extenso (Brasil). Veja a lista aqui.
Contato string Não Nome da pessoa responsável pela base para entrar em contato.
Email string Não Email do responsável da base para entrar em contato.
Telefone string Não Telefone do responsável da base para entrar em contato, no formato DDDNNNNNNNNN.
Cnpj string Não CNPJ da base, utilizando somente números.
CnpjMatriz string Não Caso a base seja filial ou associada à uma transportadora/embarcadora com CNPJ diferente, o CNPJ da associada em questão deve ser informada, utilizando somente números.
TipoMatriz string Não Se for o caso citado acima, informar o tipo da matriz. Valores permitidos:
- courier (Transportadora)
- shipper (Embarcador).
CodigoIBGE string Não Código identificador do município.
Posicao element Não Elemento para envio de posição da base.
Atributo Tipo Obrigatório Descrição
codigo string * Código de identificação da base (Ideal é que seja único).
Posição da Base

Elemento para o envio da localização da base.

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

*

Caso queira enviar o local de origem e destino final da rota, todas as TAGs que compõem esses elementos passam a ser obrigatórias.

Limites

TAG Tipo Obrigatório Descrição
inicio string Não Data/Hora limite para início da rota. Formato: AAAAMMDD HHMM .
fim string Não Data/Hora limite para fim da rota. Formato: AAAAMMDD HHMM .
#### 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

Paradas

Elemento responsável por agrupar todos os elementos Parada da rota.

TAG Tipo Obrigatório Descrição
Paradas element Sim Indicador de início da estrutura de paradas. Uma rota pode ser composta por vários elementos Parada.
Parada

Indicador de início da estrutura de uma parada.

TAG Tipo Obrigatório Descrição
Tipo 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).
Documento element Sim Indicador de início da estrutura do Documento. No caso de entregas com mais de um documento, deve-se criar uma nova parada para cada documento. O sistema identifica vários documentos em um mesmo endereço e realiza a consolidação.
Cliente element Sim Indicador de início da estrutura do Cliente. Uma parada 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 a parada.
SKUs element Sim Elemento inicializador da estrutura que contêm informações sobre todos os SKUs da parada.
Volumes element Não Elemento inicializador da estrutura que contêm informações sobre todos os Volumes da parada.
Sla element Não Elemento inicializador da estrutura que contêm informações sobre o prazo SLA SLAs da parada.
ETA element Não ETA.
Atributo Tipo Obrigatório Descrição
numero string Sim Atributo de Parada. Corresponde ao número da parada no sistema.
Documento

Indicador de início da estrutura de um documento. Uma parada deve ter um único documento. Para o caso de vários documentos para o mesmo local, deve-se criar uma parada para cada documento, pois o sistema automáticamente reconhece pelo endereço e consolida estes documentos na rota.

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.
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 AAAAMMDD.
Atualizacao string Não Data de atualização do documento. Obrigatório o formato AAAAMMDD.
Numero string Sim Número do documento. Somente números sem caracteres especiais ou espaços.
ChaveNota 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.
ValorNota string Não Valor total do documento.
ModeloDoc string Não Modelo fiscal do documento (verificar junto a SEFAZ os modelos disponíveis).
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.
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
Embarcador element Não Dados do Embarcador
CamposLivres element Não Estes campos não são replicados. CamposLivres
Itinerario element Não Dados do Itinerario
Janela
TAG Tipo Obrigatório Descrição
DataHoraIni string * Horário de início da janela de entrega/coleta, no formato AAAAMMDD HHMM.
DataHoraFim string * Horário de fim da janela de entrega/coleta, no formato AAAAMMDD HHMM.

*

Caso queira 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: AAAAMMDD**

*

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 AAAAMMDD.

Embarcador

TAG Tipo Obrigatório Descrição
Nome string * Nome do embarcador.
cnpj string * CNPJ do embarcador, estritamente numérico.

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
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 queira 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 element 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 queira 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.

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

*

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

**

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

ETA

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

TAG Tipo Obrigatório Descrição
ETAInicial string * ETA inicial, no formato: AAAAMMDD HHMM.
TempoDePermanenciaPrevisto integer * Tempo de permanencia previsto.