WS013 - Send Documents to Comprovei

Click here to see version history

Update date	Service publication date	Changes
05/25/2020	05/25/2020	Addition of the "dataSla" field
06/18/2020	06/18/2020	Addition of the "CamposLivres" tag
11/11/2020	11/11/2020	Addition of stop type "CO" (Optional Collection)
11/17/2020	11/17/2020	Creation of the contingency URL
11/24/2025	11/24/2025	Update with new volume, packaging and labeling features

Objective

This integration aims to allow the sending of one or more documents to be tracked by Comprovei©.

Method description


`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

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.

Version

You are accessing version 2 of our integration system. If you wish to consult the previous version, click here.

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

Within the <uploadDocuments> TAG:

TAG	Type	Description
`Documentos`	root	Root of the xml and composed of one or more Document.

Request Example

<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 replicate="0" owner="0">
                    <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</Anotacao>
                    <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</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</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>
                            <CodEmbalagem>String</CodEmbalagem>
                        </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>
                    <Embalagens>
                        <Embalagem codigo="String">
                            <Tipo>String</Tipo>
                            <Descricao>String</Descricao>
                            <TempMin>String</TempMin>
                            <TempMax>String</TempMax>
                            <Largura>String</Largura>
                            <Altura>String</Altura>
                            <Profundidade>String</Profundidade>
                            <PesoBruto>String</PesoBruto>
                            <PesoLiquido>String</PesoLiquido>
                            <Barcode>String</Barcode>
                            <Extras>String</Extras>
                            <Etiquetas>
                                <Etiqueta>
                                    <DataEmissao>String</DataEmissao>
                                    <DataValidade>String</DataValidade>
                                    <ConteudoImpressao>String</ConteudoImpressao>
                                    <ScanCode>String</ScanCode>
                                </Etiqueta>
                            </Etiquetas>
                        </Embalagem>
                    </Embalagens>
                    <ProtocoloMulti>String</ProtocoloMulti>
                </Documento>
            </Documentos>
        </uploadDocuments>
    </Body>
</Envelope>

Response

Our Web Service responds to you as follows:

TAG	Type	Description
`Code`	integer	Return code (see table of General Return Codes).
`Status`	string	Return message (see table of General Return Codes).
`protocolo`	string	Protocol to check the progress of the import request (Returned only if successful).
`Notifications`	element	Element composed of Notification elements, which can contain warning or error messages about each document sent.

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.

Notification

Element composed of Error or Warning elements.

TAG	Type	Description
`Error`	element	Contains the error code, document key, and message for that document.
`Warning`	element	Contains the warning code, document key, and message for that document.

Error/Warning

TAG	Type	Description
`Code`	integer	Return code (see table of Document Return Codes).
`Doc`	string	Identification key for this document.
`Mensagem`	string	Return message (see table of Document Return Codes).

Response Example

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

General Return Codes

Code	Description
0	All documents added to the import queue!
1	File identified as invalid or corrupt xml.
3	Some documents had errors. These have not been added to the import queue.
4	All documents have errors and have not been added to the import queue.
999	Unauthenticated user!

Document Return Codes

Code	Description
3	Document with this key already imported.
8	Document items are without code. Import aborted.

Our Document XML

Our XML for importing one or more documents is composed of the following TAGs:

TAG	Type	Required	Description
`Documentos`	root	Yes	Root of the xml and composed of one or more Document.

Document

Indicator of the beginning of a document's structure.

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.
`TipoParada`	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).
`Modelo`	string	No	Tax model of the document (check with SEFAZ for available models).
`Numero`	string	Yes	Document number. Only numbers without special characters or spaces.
`Valor`	string	No	Total value of the document.
`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 YYYYMMDD is mandatory.
`Atualizacao`	string	No	Document update date. The format YYYYMMDD is mandatory.
`Chave`	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.
`cnpj`	string	Yes	CNPJ (or CPF) of the recipient of the document. (numbers only).
`cnpjEmissor`	string	Yes	CNPJ of the document issuer and/or shipper. (numbers only).
`cnpjTransportador`	string	Yes	CNPJ of the transporter. (numbers only).
`cnpjConsignatario`	string	No	CNPJ of the consignee. (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.
`Rota`	element	No	Route to add the document when it is imported.
`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
`Transportadora`	element	No	Carrier
`Embracador`	element	No	Shipper
`CamposLivres`	element	No	These fields are not replicated. CamposLivres
`Cliente`	element	Yes	Customer structure start indicator. A document is associated with a single customer.
`danfes`	element	No	Initializing element of the containing structure that contains information about all danfes associated with the document.
`SKUs`	element	Yes	Structure initializing element that contains information about all SKUs in the document.
`Volumes`	element	No	Structure initializing element that contains information about all Volumes of the document.
`Itinerario`	element	No	Itinerary data
`Embalagens`	element	No	Structure initializing element that contains information about all Packaging of the document.
`ProtocoloMulti`	string	No	Integration protocol with Multi

Atributo	Type	Required	Description
`replicate`	integer	No	Number of replications
`owner`	integer	No	Owner

Route

They contain information about the route so that the document is added as soon as it is imported.

TAG	Type	Required	Description
`Nome`	string	*	Name
`Data`	string	*	Route date, in the format YYYYMMDD.
`Motorista`	string	*	Code of the driver responsible for the route.

*

If you want to add this document to a route as soon as it is imported, all TAGs that make up this element become mandatory.

Window

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

*

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

Sla

TAG	Type	Required	Description	Format/Restrictions
`DiasUteis`	integer	*	Number of working days that the carrier has to finalize the document.**	Default value: 0. *Mandatory if DataSla is not provided
`DataSla`	string	*	Deadline that the carrier has to finalize the document.**	Minimum 8 characters format YYYMMDD 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
`PedidoInterno`	string	*	Internal Order Number.
`PedidoCliente`	string	*	Number Sent to Customer Order
`DataPedido`	string	*	Route date, in the format YYYYMMDD.

Carrier

TAG	Type	Required	Description
`cnpj`	string	*	CNPJ of the carrier.
`Nome`	string	*	Name of the carrier.

*

If you want to add this document to a route as soon as it is imported, all TAGs that make up this element become mandatory.

Shipper

TAG	Type	Required	Description
`cnpj`	string	*	Shipper's CNPJ.
`Nome`	string	*	Shipper's name.

*

If you want to add this document to a route as soon as it is imported, all TAGs that make up this element become mandatory.

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

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.
`NomeTrajeto`	string	No	Route name.

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 wish to inform DANFE of a document, all TAGs that make up this 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
`CodFabricante`	string	*	Batch manufacturer code.
`NomeFabricante`	string	*	Name of the Batch manufacturer.
`DataFabricacao`	string	*	Lot manufacturing date in the format: YYYY-MM-DD.
`DataValidade`	string	*	Lot expiration date in the format: YYYY-MM-DD.
`CodAnvisa`	string	*	ANVISA Code for the Lot, in the format: 13 numeric digits, EXEMPT or empty.

Atributo	Type	Required	Description
`codigo`	string	*	Batch attribute. Corresponds to the Lot code.

*

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	*	Description 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. It is associated with the CodVolume of the SKU

*

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

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

Packaging

TAG	Type	Required	Description
`Embalagens`	element	No	Indicator of the beginning of the packaging structure, referenced in the volumes tag. A document can contain several Packaging.

Packaging (inside Packaging)

TAG	Type	Required	Description
`Tipo`	string	Yes	Packaging type
`Descricao`	string	Yes	Packaging description
`TempMin`	string	Yes	Minimum temperature
`TempMax`	string	Yes	Maximum temperature
`Largura`	string	Yes	Width
`Altura`	string	Yes	Height
`Profundidade`	string	Yes	Depth
`PesoBruto`	string	Yes	Gross weight
`PesoLiquido`	string	Yes	Net weight
`Barcode`	string	Yes	Barcode
`Extras`	string	Yes	Extra information
`Etiquetas`	complex	No	List of Tags

Atributo	Type	Required	Description
`codigo`	string	Yes	Packaging attribute. Corresponds to the packaging code. It is associated with CodEmbalagem of the Volume tag

Label

TAG	Type	Required	Description
`DataEmissao`	string	Yes	Issue date
`DataValidade`	string	No	Expiration date
`ConteudoImpressao`	string	No	Printable content
`ScanCode`	string	No	Scan code

WS013 - Send Documents to Comprovei

Objective

Method description

Features

Authentication

Request

Header

Body

Request Example

Response

Notification

Error/Warning

Response Example

General Return Codes

Document Return Codes

Our Document XML

Document

Route

Window

Sla

InfosRequest

Carrier

Shipper

CamposLivres

Customer

Customer Position

Danfes

Danfe

SKUs

SKU

Lot

Volumes

Volume

Itinerary

Packaging

Packaging (inside Packaging)

Tags

Label