Pular para conteúdo

WS013 - Enviar Documentos 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/05/2020 25/05/2020 Acréscimo do campo "dataSla"
18/06/2020 18/06/2020 Acréscimo da tag "CamposLivres"
11/11/2020 11/11/2020 Acréscimo tipo de parada "CO" (Coleta Opcional)
17/11/2020 17/11/2020 Criação da URL de contingência

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 2
WSDL principal https://soap.comprovei.com.br/importQueue/v2/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/MultiDocument.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.
  3. 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.

Versão

Você está acessando a versão 2 do nosso sistema de integração. Caso deseje consultar a versão anterior, 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 <uploadDocuments>:

TAG Tipo Descrição
Documentos root Raiz do xml e composto por composto por um ou mais Documento.

Exemplo de Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <Credenciais xmlns="WebServiceComprovei">
            <Usuario>usuario</Usuario>
            <Senha>senha</Senha>
        </Credenciais>
    </Header>
    <Body>
        <uploadDocuments xmlns="WebServiceComprovei:uploadDocuments">
            <Documentos>
                <Documento>
                    <Tipo>String</Tipo>
                    <TipoParada>String ("E", "T", "C", "CA", "CA2", "CG", "CO", "CIE" ou "R")</TipoParada>
                    <Modelo>String</Modelo>
                    <Numero>String</Numero>
                    <Valor>String</Valor>
                    <Serie>String</Serie>
                    <Emissao>String</Emissao>
                    <Atualizacao>String</Atualizacao>
                    <Chave>String</Chave>
                    <cnpj>String</cnpj>
                    <cnpjEmissor>12345678String901234</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</String>
                    <Agendamento>String</Agendamento>
                    <PesoLiquido>String</PesoLiquido>
                    <Volume>String</Volume>
                    <Rota>
                        <Nome>String</Nome>
                        <Data>String</Data>
                        <Motorista>String</Motorista>
                    </Rota>
                    <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>
                    <Transportadora>
                        <cnpj>String</cnpj>
                        <Nome>String</Nome>
                    </Transportadora>
                    <Embarcador>
                        <cnpj>String</cnpj>
                        <Nome>String</Nome>
                    </Embarcador>
                    <CamposLivres>
                        <CampoLivre1>String</CampoLivre1>
                        <CampoLivre2>String</CampoLivre2>
                        <CampoLivre3>String</CampoLivre3>
                        <CampoLivre4>String</CampoLivre4>
                        <CampoLivre5>String</CampoLivre5>
                    </CamposLivres>
                    <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>String</Latitude>
                            <Longitude>String</Longitude>
                        </Posicao>
                        <CodigoGrupo>String</CodigoGrupo>
                        <DescricaoGrupo>String</DescricaoGroup>
                        <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</DataFabricacao>
                                <DataValidade>String</DataValidade>
                                <CodAnvisa>String</CodAnvisa>
                            </Lote>
                            <CodVolume>String</CodVolume>
                            <BU>String</BU>
                        </SKU>
                    </SKUs>
                    <Volumes>
                        <Volume codigo="String">
                            <PesoBruto>String</PesoBruto>
                            <PesoLiquido>String</PesoLiquido>
                            <Uom>String</Uom>
                            <BarCode>String</BarCode>
                        </Volume>
                    </Volumes>
                    <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>
                        <CnpjTransportador1>String</CnpjTransportador1>
                        <NomeTransportador1>String</NomeTransportador1>
                        <Filial>String</Filial>
                    </Itinerario>
                </Documento>
            </Documentos>
        </uploadDocuments>
    </Body>
</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  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  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  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  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