WS011 - Send new Documents to a Route already imported into Comprovei

Click here to see version history

Update date	Service publication date	Changes
05/25/2020	05/25/2020	Addition of the dataSla field
05/25/2020	05/25/2020	Addition of the "dataSla" field
11/11/2020	11/11/2020	Addition of stop type "CO" (Optional Collection)
11/17/2020	11/17/2020	Creation of the contingency URL

Objective

This integration aims to allow sending a route update so that new documents can be added to Comprovei©

Method description


`Método`	uploadRoute
`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/Planilha.xsd

Important

The connection to our service must be made to our main server, however we strongly suggest that a connection to our contingency server is also made available, as a guarantee of the availability of our services. The contingency server is only turned on in situations where our main server is unavailable. Making the connection url parameterizable is also a good practice;
Our connections are secure using the SSL protocol. For security reasons, our certificates are constantly changed without prior notice. Therefore, it is recommended that you do not develop integrations based on a fixed certificate.
We constantly (and without prior notice) add new fields and structures to both requests and responses from our web services. Anyone who uses our webservices must implement it in such a way that the programs that consume these webservices do not stop working when the mentioned field changes occur.

Features

Calls will be made via SOAP over HTTPS;
The origin of the Web Service call will be the client's system;

Important

The user of this Web Service must store the protocol generated in the response. Support tickets regarding this integration will require this protocol.

Authentication

Calls will have message-level authentication (SOAP Header);
Request the username / password from the account administrator.

Request

The request for our Web Service is composed as follows:

Within the <Credentials> TAG:

TAG	Type	Description
`Usuario`	string	User for authentication.
`Senha`	string	User password for authentication

Body

Inside the <uploadRoute> TAG:

TAG	Type	Description
`Rotas`	root	Root of the xml and composed of Rota.
`nomeArquivo`	string	Name of the sent file, with the extension. Example: route.xml.

Shipping

Send the same route information that was previously imported and at the stops add only the new documents that will be imported.

Important

Before the first route update,support@comprovei.com must be informed to enable the necessary settings for this type of operation.

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header>
        <Credenciais xmlns="WebServiceComprovei">
            <Usuario>usuario</Usuario>
            <Senha>teste</Senha>
        </Credenciais>
    </Header>
    <Body>
        <uploadRoute xmlns="WebServiceComprovei:uploadRoute">
            <Rotas>
                <Rota numero="0403645401">
                    <rotadestino>DestinoDaRota</rotadestino>
                    <rotanome>NomeDaRota</rotanome>
                    <Data>20190107</Data>
                    <Regiao>RegiaoDaRota</Regiao>
                    <Transportadora>
                        <Codigo>12345678901234</Codigo>
                        <Razao>RazaoDaTransportadora</Razao>
                    </Transportadora>
                    <Motorista>
                        <Usuario>12345678901</Usuario>
                        <PlacaVeiculo>AAA1234</PlacaVeiculo>
                    </Motorista>
                    <Base>
                        <Origem codigo="codigobasedeorigem">
                            <Nome>NomeDaBaseDeOrigem</Nome>
                            <Rua>RuaDaBaseDeOrigem</Rua>
                            <Numero>1234</Numero>
                            <Complemento>ComplementoDaBaseDeOrigem</Complemento>
                            <Bairro>BairroDaBaseDeOrigem</Bairro>
                            <Cidade>CidadeDaBaseDeOrigem</Cidade>
                            <Estado>UFDaBaseDeOrigem</Estado>
                            <CEP>CEPDaBaseDeOrigem</CEP>
                            <Pais>BR</Pais>
                            <CodigoIBGE>12345678</CodigoIBGE>
                        </Origem>
                        <Destino codigo="codigobasededestino">
                            <Nome>NomeDaBaseDeDestino</Nome>
                            <Rua>RuaDaBaseDeDestino</Rua>
                            <Numero>1234</Numero>
                            <Complemento>ComplementoDaBaseDeDestino</Complemento>
                            <Bairro>BairroDaBaseDeDestino</Bairro>
                            <Cidade>CidadeDaBaseDeDestino</Cidade>
                            <Estado>UFDaBaseDeDestino</Estado>
                            <CEP>CEPDaBaseDeDestino</CEP>
                            <Pais>BR</Pais>
                            <CodigoIBGE>12345678</CodigoIBGE>
                        </Destino>
                    </Base>
                    <limites>
                        <inicio>20190107 0800</inicio>
                        <fim>20190107 1800</fim>
                    </limites>
                    <TipoRota>D</TipoRota>
                    <TipoMaterial>TipoMaterialTransportado</TipoMaterial>
                    <Fornecimento>CodigoFornecimentoRota</Fornecimento>
                    <TipoFrete>TipoFreteDaRota</TipoFrete>
                    <CamposLivres>
                        <CampoLivre1></CampoLivre1>
                        <CampoLivre2></CampoLivre2>
                        <CampoLivre3></CampoLivre3>
                        <CampoLivre4></CampoLivre4>
                        <CampoLivre5></CampoLivre5>
                    </CamposLivres>
                    <Paradas>
                        <Parada numero="2">
                            <Tipo>E</Tipo>
                            <Documento>
                                <Tipo>NFE</Tipo>
                                <Serie>1</Serie>
                                <Emissao>20190109</Emissao>
                                <Numero>0987654321</Numero>
                                <ChaveNota>35001120316100123473670002605556715046108001</ChaveNota>
                                <ValorNota>170.00</ValorNota>
                                <ModeloDoc>ModeloDoDocumento</ModeloDoc>
                                <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>20190109</Agendamento>
                                <PesoLiquido>1</PesoLiquido>
                                <Volume>1</Volume>
                                <Janela>
                                    <DataHoraIni>20190109 0800</DataHoraIni>
                                    <DataHoraFim>20190109 1600</DataHoraFim>
                                </Janela>
                                <TipoMaterial>TipoMaterialDocumento</TipoMaterial>
                                <Fornecimento>CodigoFornecimentoDocumento</Fornecimento>
                                <TipoFrete>Expresso</TipoFrete>
                                <Modal>Rodoviario</Modal>
                                <Sla>
                                    <DiasUteis></DiasUteis>
                                </Sla>
                                <InfosPedido>
                                    <InfoPedido>
                                        <PedidoInterno>256389</PedidoInterno>
                                        <PedidoCliente>5652147</PedidoCliente>
                                        <DataPedido>20190108</DataPedido>
                                    </InfoPedido>
                                </InfosPedido>
                                <CamposLivres>
                                    <CampoLivre1></CampoLivre1>
                                    <CampoLivre2></CampoLivre2>
                                    <CampoLivre3></CampoLivre3>
                                    <CampoLivre4></CampoLivre4>
                                    <CampoLivre5></CampoLivre5>
                                </CamposLivres>
                            </Documento>
                            <Cliente>
                                <Codigo>789456</Codigo>
                                <codigointerno>B198755A</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>
                                <vendedorcodigo>CodigoDoVendedorDaConta</vendedorcodigo>
                                <vendedornome>NomeDoVendedorDaConta</vendedornome>
                                <vendedoremail>EmailDoVendedorDaConta</vendedoremail>
                                <vendedorcelular>CelularDoVendedorDaConta</vendedorcelular>
                                <gerentecodigo>CodigoDoGerenteDaConta</gerentecodigo>
                                <gerentenome>NomeDoGerenteDaConta</gerentenome>
                                <gerenteemail>EmailDoGerenteDaConta</gerenteemail>
                                <gerentecelular>CelularDoGerenteDaConta</gerentecelular>
                                <supervisorcodigo>CodigoDoSupervisorDaConta</supervisorcodigo>
                                <supervisornome>NomeDoSupervisorDaConta</supervisornome>
                                <supervisoremail>EmailDoSupervisorDaConta</supervisoremail>
                                <supervisorcelular>CelularDoSupervisorDaConta</supervisorcelular>
                                <gerentecelular>CelularDoGerenteDaConta</gerentecelular>
                                <gerenteseniorcodigo>CodigoDoGerenteSeniorDaConta</gerenteseniorcodigo>
                                <gerenteseniornome>NomeDoGerenteSeniorDaConta</gerenteseniornome>
                                <gerentesenioremail>EmailDoGerenteSeniorDaConta</gerentesenioremail>
                                <gerenteseniorcelular>CelularDoGerenteSeniorDaConta</gerenteseniorcelular>
                                <CodigoIBGE>1234567</CodigoIBGE>
                            </Cliente>
                            <danfes>
                                <danfe NumDanfe="1234567890">
                                    <SerieDanfe>1</SerieDanfe>
                                    <chavedanfe>35001120316100123473670002605556715046108001</chavedanfe>
                                    <dataemissaodanfe>20190109</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>
                            <Volumes>
                            </Volumes>
                            <Sla>
                                <DiasUteis>0</DiasUteis>
                            </Sla>
                        </Parada>
                    </Paradas>
                </Rota>
            </Rotas>
            <nomeArquivo>rotaupdate.xml</nomeArquivo>
        </uploadRoute>
    </Body>
</Envelope>

Response

Our Web Service responds to you as follows:

TAG	Type	Description
`status`	string	Success or error message for the method call.
`protocolo`	string	Protocol for checking the progress of the import request.

Protocol

When a file is accepted into our system, a protocol is generated so that the import process can be monitored. This can be done using the WS501 method.

Response Example

Success

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

Our Route XML

Our XML for importing a route is composed of the following TAGs:

TAG	Type	Required	Description
`Rotas`	root	Yes	Root of the xml and composed of Rota.

Route

TAG	Type	Required	Description
`rotadestino`	string	No	Indication of the destination or route itinerary (limited to 30 characters).
`rotanome`	string	No	Indication of the route name.
`Data`	string	Yes	Route operation start date. The format YYYYMMDD is mandatory.
`Regiao`	string	No	Route region.
`Transportadora`	element	Yes	Structure initial element that contains information about the Transporter that will execute the route.
`Motorista`	element	Yes	Structure initializer element that contains information about the Driver that will execute the route.
`Base`	element	No	Structure initial element that contains information about the Base of origin and destination of the route.
`limites`	element	No	Initializing element of the structure that contains information about the dates and times Limits of the start and end of the route.
`TipoRota`	string	No	Type of route sent. Allowed values: - D (Distribution) - T (Transshipment) - P (Place) - R (Return)
`TipoMaterial`	string	No	Type of route material.
`Fornecimento`	string	No	Route supply code.
`TipoFrete`	string	No	Type of freight contracted for the route.
`Modal`	string	No	Transport mode
`CamposLivres`	element	No	These fields are not replicated. CamposLivres
`Paradas`	element	Yes	Structure initializer element that contains information about all Stops that will be made by the driver.
`Observacao`	string	No	Observations about the route

Atributo	Type	Required	Description
`numero`	string	Yes	Route attribute. Corresponds to the route number in the system.
`replicate`	integer	No	Number of replications

Carrier

Conveyor structure start indicator. A route can contain a single carrier.

TAG	Type	Required	Description
`Codigo`	string	Yes	Carrier code. Normally it is the CNPJ. Send numbers only.
`Razao`	string	Yes	Name of the carrier. You can use a short name (business name).

If you do not have this information, the fields must be sent without content (empty).

Driver

Driver structure start indicator. A route can contain a single driver.

TAG	Type	Required	Description
`Usuario`	string	Yes	Driver code registered with Comprovei.
`PlacaVeiculo`	string	Yes	Vehicle plate in the format: AAA9999 (without dash or space).
`TipoVeiculo`	string	No	Type of vehicle that will be used to complete the route.
`Nome`	string	No	Driver's name. This field will only be used when automatic driver registration is necessary!.
`Telefone`	string	No	Driver's telephone number, in the format DDDNNNNNNNNN. This field will only be used when automatic driver registration is necessary!.
`CNH`	element	No	Driver's license. This element will only be used when automatic driver registration is necessary!.
`CPF`	string	No	Driver's CPF without dashes and dots. This field will only be used when automatic driver registration is necessary!.

If you do not have this information, the fields must be sent without content (empty) and the route will be associated with a driver manually.

The CNH element is composed as follows:

TAG	Type	Required	Description
`Numero`	string	*	Driver's driver's license number.
`Vencimento`	string	*	Expiration date of the driver's driver's license, in the format YYYMMDD.

*

The fields are mandatory if you want to provide the driver's driver's license.

Base

Indicator of the beginning of the structure of the source and destination bases. This information is optional and must be filled in when using routing.

TAG	Type	Required	Description
`Origem`	element	*	Route start location.
`Destino`	element	*	Route end location.

Source and Destination are composed as follows:

TAG	Type	Required	Description
`Nome`	string	*	Base registration name.
`Rua`	string	*	Street of the base of origin (Street, Avenue, Square, etc.).
`Numero`	string	*	Base number.
`Complemento`	string	*	Complement of the base address.
`Bairro`	string	*	Base neighborhood.
`Cidade`	string	*	Base city.
`Estado`	string	*	UF of the base (For example: SP, MG).
`CEP`	string	*	ZIP code (only numbers, without dashes or spaces) of the base.
`Pais`	string	*	Base country, in alpha-2 (BR), alpha-3 (BRA) or in full (Brazil). See the list here.
`Contato`	string	No	Name of the person responsible for the base to contact.
`Email`	string	No	Email of the person responsible for the base to get in touch.
`Telefone`	string	No	Telephone number of the person responsible for the base to contact, in the format DDDNNNNNNNNN.
`Cnpj`	string	No	CNPJ of the base, using Maximum 14 digits only numbers.
`CnpjMatriz`	string	No	If the base is a branch or associated with a carrier/shipper with a different CNPJ, the CNPJ of the associate in question must be informed, using Maximum 14 digits only numbers.
`TipoMatriz`	string	No	If this is the case mentioned above, inform the type of matrix. Allowed values: - courier (Carrier) - shipper (Shipper).
`CodigoIBGE`	string	No	Municipality identifier code.
`Posicao`	element	No	Element for sending position of the base.

Atributo	Type	Required	Description
`codigo`	string	*	Base identification code (Ideally, it should be unique).

Base Position

Element for sending the base location.

TAG	Type	Required	Description
`Latitude`	decimal	*	Base latitude, in decimal. Ex.: -23.5489
`Longitude`	decimal	*	Base length, in decimal. Ex.: 46.6388

*

If you want to send the location of origin and final destination of the route, all TAGs that make up these elements become mandatory.

Limits

TAG	Type	Required	Description
`inicio`	string	No	Deadline date/time for starting the route. Format: YYYYMMDD HHMM .
`fim`	string	No	Deadline date/time for the end of the route. Format: YYYYMMDD HHMM .
#### CamposLivres

TAG	Type	Required	Description
`CampoLivre1`	string	No	Free Field
`CampoLivre2`	string	No	Free Field
`CampoLivre3`	string	No	Free Field
`CampoLivre4`	string	No	Free Field
`CampoLivre5`	string	No	Free Field

Stops

Element responsible for grouping all Stop elements of the route.

TAG	Type	Required	Description
`Paradas`	element	Yes	Stop structure start indicator. A route can be composed of several elements Stop.

Stop

Indicator of the start of a stop structure.

TAG	Type	Required	Description
`Tipo`	string	Yes	Type of stop sent. Allowed values: - E (Delivery). - T (Transshipment). - C (Collection). - CA (Collection). - CA2 (Collection). - CG (Collection). - CO (Collection). - CIE (Collection). - R (Return).
`Mensagem`	string	No	Stop message
`Documento`	element	Yes	Document structure start indicator. In the case of deliveries with more than one document, a new stop must be created for each document. The system identifies several documents at the same address and performs consolidation.
`Cliente`	element	Yes	Customer structure start indicator. A stop is associated with a single customer.
`danfes`	element	No	Initializing element of the containing structure that contains information about all Danfes associated with the stop.
`SKUs`	element	Yes	Structure initializing element that contains information about all SKUs of the stop.
`Volumes`	element	No	Structure initialization element that contains information about all Volumes of the stop.
`Sla`	element	No	Structure initializing element that contains information about the SLA deadline SLAs of the stop.
`ETA`	element	No	ETA.
`Embalagens`	element	No	Structure initializing element that contains information about all Packaging of the stop.

Atributo	Type	Required	Description
`numero`	string	Yes	Stop attribute. Corresponds to the stop number in the system.

Document

Indicator of the beginning of a document's structure. A stop must have a single document. In the case of several documents for the same location, a stop must be created for each document, as the system automatically recognizes the address and consolidates these documents on the route.

TAG	Type	Required	Description
`Tipo`	string	Yes	Document type (NFE, OS, CTE, etc.). There is no validation for this information and is for reference only.
`Serie`	string	Yes	Document series (in the case of NFe). If not, send value 0.
`Emissao`	string	Yes	Date of issue of the document. The format YYYMMDD is mandatory.
`Atualizacao`	string	No	Document update date. The format YYYMMDD is mandatory.
`Numero`	string	Yes	Document number. Only numbers without special characters or spaces.
`FotoItem`	string	No	Item Photo
`ChaveNota`	string	Yes	Document key. Normally it is the tax document key (barcode). This field is mandatory and its content must be unique for different documents.
`ValorNota`	string	No	Total value of the document.
`ModeloDoc`	string	No	Tax model of the document (check with SEFAZ for available models).
`Cnpj`	string	Yes	CNPJ (or CPF) of the recipient of the document. (Maximum 14 digits numbers only).
`CnpjEmissor`	string	Yes	CNPJ of the document issuer and/or shipper. (Maximum 14 digits numbers only).
`CnpjTransportador`	string	Yes	CNPJ of the transporter. (Maximum 14 digits numbers only).
`CnpjConsignatario`	string	No	CNPJ of the consignee. (Maximum 14 digits numbers only).
`Romaneio`	string	No	Document mailing number.
`Remessa`	string	No	Document shipment number.
`Pedido`	string	No	Document order number.
`Placa`	string	No	License plate of the vehicle associated with the document.
`Filial`	string	No	Branch associated with the document.
`Peso`	string	No	Gross weight of the document load.
`Cubagem`	string	No	Total document load volume.
`ONU`	string	No	Dangerousness code for the document load.
`Anotacao`	string	No	Annotation on the document.
`Agendamento`	string	No	Document scheduling date.
`PesoLiquido`	string	No	Net weight of the document load.
`Volume`	string	No	Number of document volumes.
`Janela`	element	No	Window of delivery.
`TipoMaterial`	string	No	Type of document material.
`Fornecimento`	string	No	Document supply code.
`TipoFrete`	string	No	Type of freight contracted for the document.
`Modal`	string	No	Mode of transport contracted for the document.
`Sla`	element	No	Sla of the document.
`InfosPedido`	element	No	InfosRequest
`Embarcador`	element	No	Shipper data
`CamposLivres`	element	No	These fields are not replicated. CamposLivres
`Itinerario`	element	No	Itinerary data
`ProtocoloMulti`	string	No	Integration protocol with Multi

Window

TAG	Type	Required	Description
`DataHoraIni`	string	*	Start time of the delivery/collection window, in the format YYYMMDD HHMM.
`DataHoraFim`	string	*	End time of the delivery/collection window, in the format YYYMMDD HHMM.

*

If you want to inform the document delivery window, all TAGs that make up this element become mandatory.

Sla

TAG	Type	Required	Description
`DiasUteis`	integer	*	Number of business days that the carrier has to finalize the document.* Default value: 0. Mandatory if DataSla is not informed
`DataSla`	string	*	Deadline that the carrier has to finalize the document. Minimum 8 characters format YYYYMMDD HHMM or YYYMMDD*. Mandatory if DiasUteis is not informed

*

If you want to inform the SLA of the document, the TAG DaysWorking or DataSla becomes mandatory.

**

Only one of the options is accepted, that is, send only to DataSla or DiasUteis

InfosRequest

TAG	Type	Required	Description
`InfoPedido`	complex	Yes	Order information (may repeat)

InfoRequest

TAG	Type	Required	Description
`PedidoInterno`	string	Yes	Internal Order Number.
`PedidoCliente`	string	Yes	Number Sent to Customer Order
`DataPedido`	string	Yes	Order date, in the format YYYMMDD.

Shipper

TAG	Type	Required	Description	Format/Restrictions
`cnpj`	string	No	Shipper's CNPJ	Maximum 14 characters, numbers only
`Nome`	string	No	Shipper's name

Itinerary

TAG	Type	Required	Description	Format/Restrictions
`ChaveUnica`	string	Yes	Unique itinerary key	Minimum 1 character
`Codigo`	string	Yes	Itinerary code	Minimum 1 character
`Descricao`	string	No	Itinerary description
`CodigoDeBarras`	string	No	Itinerary barcode
`Data`	string	No	Itinerary date
`Turno`	string	No	Itinerary shift
`Prioridade`	string	No	Itinerary priority
`Tipo`	string	No	Itinerary type
`PontoTransbordo1`	string	No	Transshipment point 1
`CnpjTransportador1`	string	No	CNPJ of transporter 1
`NomeTransportador1`	string	No	Carrier name 1
`Filial`	string	No	Branch

Customer

Client structure start indicator. A document is associated with a single customer.

TAG	Type	Required	Description
`Codigo`	string	Yes	Customer code (or CNPJ). This code is strictly numeric.
`codigointerno`	string	No	Internal or alternative customer code.
`Contato`	string	Yes	Contact name of the recipient customer.
`Telefone`	string	Yes	Cell phone (for sending SMS) of the recipient customer's contact. Send only the numbers, in the format DDDNNNNNNNNN.
`Email`	string	Yes	Email (for sending emails) of the recipient customer's contact.
`Razao`	string	Yes	Business name or business name of the recipient customer.
`Endereco`	string	Yes	Delivery address of the recipient customer. Only street and number, separated by a comma (",").
`Bairro`	string	Yes	Neighborhood of the recipient customer.
`Cidade`	string	Yes	City of the recipient customer.
`Estado`	string	Yes	State (UF) of the recipient customer.
`Pais`	string	Yes	Country of the recipient customer, in alpha-2 (BR), alpha-3 (BRA) or in full (Brazil). See the list here.
`CEP`	string	Yes	Delivery address zip code.
`Regiao`	string	No	Region or branch or route of the delivery address.
`TipoCliente`	string	No	Free field to differentiate, in the system, whether the customer in question is special or common.
`Mensagem`	string	No	Informative text for the driver about the customer. Ex.: Deliver on the 2nd. Room 21.
`vendedorcodigo`	string	No	Account seller code.
`vendedornome`	string	No	Name of the account seller.
`vendedoremail`	string	No	Email account of the account seller.
`vendedorcelular`	string	No	Account seller's cell phone in the format DDDNNNNNNNNN.
`supervisorcodigo`	string	No	Account supervisor code.
`supervisornome`	string	No	Name of the account supervisor.
`supervisoremail`	string	No	Account supervisor email account.
`supervisorcelular`	string	No	Account supervisor's cell phone in the format DDDNNNNNNNNN.
`gerentecodigo`	string	No	Account manager code.
`gerentenome`	string	No	Name of the account manager.
`gerenteemail`	string	No	Account manager's email account.
`gerentecelular`	string	No	Account manager's cell phone in the format DDDNNNNNNNNN.
`gerenteseniorcodigo`	string	No	Senior account manager code.
`gerenteseniornome`	string	No	Name of the senior account manager.
`gerentesenioremail`	string	No	Senior account manager's email account.
`gerenteseniorcelular`	string	No	Senior account manager's cell phone in the format DDDNNNNNNNNN.
`CodigoIBGE`	string	No	Municipality identifier code.
`Posicao`	element	No	Element for sending the customer's position.
`CodigoGrupo`	string	No	Group code.
`DescricaoGrupo`	string	No	Group description.
`CodigoTrajeto`	string	No	Route code for routes with predefined headers.
`NomeTrajeto`	string	No	Route name for routes with predefined headers.

Customer Position

Element for sending the customer's location.

TAG	Type	Required	Description
`Latitude`	decimal	*	Customer latitude, in decimal. Ex.: -23.5489
`Longitude`	decimal	*	Customer longitude, in decimal. Ex.: -46.6388

*

If you want to inform a customer's position, all TAGs that make up this element become mandatory.

Danfes

Element responsible for grouping all danfe elements of the document.

TAG	Type	Required	Description
`danfes`	element	No	Indicator of the beginning of the DANFE structure associated with the delivery document. A document can have more than one danfe.

Danfe

Contains information about the DANFE of the document.

TAG	Type	Required	Description
`SerieDanfe`	string	*	NF-e series.
`chavedanfe`	string	*	NF-e key.
`dataemissaodanfe`	string	*	Date of issue of this NF-e, in the format YYYMMDD.

Atributo	Type	Required	Description
`NumDanfe`	string	*	Danfe attribute. Corresponds to the NF-e number.

*

If you want to inform DANFE of a document, all the TAGs that make up that element become mandatory.

SKUs

Element responsible for grouping all SKU elements.

TAG	Type	Required	Description
`SKU`	element	Yes	Contains information about the item to be delivered/collected to the end customer. A SKU can be a product, a volume, a pallet, etc.

SKU

Contains information about the item to be delivered/collected.

TAG	Type	Required	Description
`PesoBruto`	string	Yes	Total gross weight of this SKU.
`PesoLiquido`	string	Yes	Total net weight of this SKU.
`Volumes`	string	Yes	Total number of volumes of this SKU.
`Descricao`	string	Yes	Description of this SKU.
`Qde`	string	Yes	Total quantity of this SKU.
`Uom`	string	Yes	Unit of measure for this SKU.
`Barcode`	string	Yes	Barcode of this SKU (for checking).
`Lote`	element	No	Contains information about the batch of this SKU.
`CodVolume`	string	No	volume code to be associated with this SKU, if desired. When sending this tag, it will look for a Volumes/Volume tag with the same code in the same send to associate the volume with this item. If it does not exist, the shipment will be cancelled.
`BU`	string	No	Business Unit

Atributo	Type	Required	Description
`codigo`	string	Yes	SKU attribute. Corresponds to the SKU code.

Lot

TAG	Type	Required	Description	Format/Restrictions
`CodFabricante`	string	Yes	Manufacturer code	Must contain at least one non-space character
`NomeFabricante`	string	Yes	Manufacturer name	Must contain at least one non-space character
`DataFabricacao`	string	Yes	Manufacturing date	Format: YYYY-MM-DD or empty
`DataValidade`	string	Yes	Expiration date	Format: YYYY-MM-DD or empty
`CodAnvisa`	string	Yes	ANVISA Code	Format: up to 13 digits or "EXEMPT"

Atributo	Type	Required	Description	Format/Restrictions
`codigo`	string	Yes	Batch attribute. Corresponds to the Lot code.	Cannot contain spaces

*

If you want to inform the Lot of an item, all TAGs that make up this element become mandatory.

Volumes

Element responsible for grouping all Volume elements.

TAG	Type	Required	Description
`Volume`	element	No	Contains information about the volume of the document.

Volume

Contains information about the volume of the document.

TAG	Type	Required	Description
`PesoBruto`	string	*	Total gross weight of this volume.
`PesoLiquido`	string	*	Total net weight of this volume.
`Uom`	string	*	Unit of measurement of this volume.
`Barcode`	string	*	Barcode for this volume.
`CodEmbalagem`	string	No	[packaging] code (#packaging) to be associated with this Volume, if desired. When sending this tag, it will look for a Packaging/Packaging tag with the same code in the same shipment to associate the packaging with this volume. If it does not exist, the shipment will be cancelled.

Atributo	Type	Required	Description
`codigo`	string	*	Volume attribute. Corresponds to the volume code.

*

If you want to inform the volume of a document, all TAGs that make up this element become mandatory.

Sla

TAG	Type	Required	Description
`DiasUteis`	integer	*	Number of business days that the carrier has to complete the stop.** Default value: 0. *Mandatory if DataSla is not informed
`DataSla`	string	*	Deadline that the carrier has to complete the stop. Minimum 8 characters format YYYYMMDD HHMM or YYYMMDD*. Mandatory if DiasUteis is not informed

*

If you want to inform the SLA of the stop, the TAG DiasUteis or DataSla becomes mandatory.

**

Only one of the options is accepted, that is, send only to DataSla or DiasUteis

ETA

Contains information about the ETA of the document.

TAG	Type	Required	Description	Format/Restrictions
`ETAInicial`	string	Yes	Initial ETA	Initial ETA, in the format: YYYMMDD HHMM
`TempoDePermanenciaPrevisto`	integer	No	Expected length of stay (in minutes)	Default value: 0

Packaging

They will contain one or more volumes, described in the volumes tag.

TAG	Type	Required	Description
`Embalagens`	element	No	Packaging structure start indicator. A stop can contain several Packaging.

Packaging (inside Packaging)

TAG	Type	Required	Description	Format/Restrictions
`Tipo`	string	Yes	Packaging type	Minimum 1 character
`Descricao`	string	No	Packaging description
`Duracao`	string	No	Duration
`TempMin`	string	No	Minimum temperature
`TempMax`	string	No	Maximum temperature
`Largura`	string	No	Width
`Altura`	string	No	Height
`Profundidade`	string	No	Depth
`PesoBruto`	string	No	Gross weight
`PesoLiquido`	string	No	Net weight
`Barcode`	string	No	Barcode
`Extras`	string	No	Extra information	Mandatory JSON format
`Etiquetas`	complex	No	List of Tags

Atributo	Type	Required	Description
`codigo`	string	Yes	Packaging attribute. Corresponds to the packaging code.

Label

TAG	Type	Required	Description	Format/Restrictions
`DataEmissao`	string	Yes	Issue date	Format YYYYMMDD HHMM
`DataValidade`	string	No	Expiration date	Format YYYYMMDD HHMM
`ConteudoImpressao`	string	No	Printable content
`ScanCode`	string	No	Scan code

WS011 - Send new Documents to a Route already imported into Comprovei

Objective

Method description

Features

Authentication

Request

Header

Body

Shipping

Request Example

Response

Response Example

Success

Our Route XML

Route

Carrier

Driver

Base

Base Position

Limits

Stops

Stop

Document

Window

Sla

InfosRequest

InfoRequest

Shipper

Itinerary

Customer

Customer Position

Danfes

Danfe

SKUs

SKU

Lot

Volumes

Volume

Sla

ETA

Packaging

Packaging (inside Packaging)

Tags

Label