Liberação de Embarque

Esta integração visa recepcionar as Liberações de Embarque vindas da Embarcadora, com o objetivo de vincular os Embarques aos Documentos Fiscais, que podem já ter sido recebidos e estar disponíveis na base de dados ou a ser recebidos posteriormente, disponibilizando assim, esses documentos para que seja realizado o Download pelo Transportador, para que este possa emitir os documentos fiscais do Transporte.

A mesma Liberação de Embarque pode ser enviada mais de uma vez, sendo que será mantida sempre a última recebida, descartando todas as anteriores. Desta forma a Embarcadora pode adicionar e remover documentos ao Embarque apenas enviando a lista de documentos atual, bem como remover todos os documentos da Liberação de Embarque, enviando a lista de documentos vazia.

Para envio das Liberações de Embarque deverá ser utilizado o método abaixo:

Observação: Caso seja informado a tag <OrderRelease> em apenas parte das chaves sendo liberadas, a Liberação de Embarque será rejeitada pelo sistema, se tornando obrigatorio informar a tag e todas as chaves a serem liberadas.

•Send.

A postagem da Liberação de Embarque deve ser feita conforme o padrão CrosstalkMessage, o qual é composto pelo Header e RawData.

•Header

O Header contém as informações básicas que identificam a Embarcadora e a forma de processamento da mensagem, conforme o schema: CrosstalkHeader, detalhado abaixo:

Exemplo XML Header:

</CrosstalkHeader>

Detalhamento do Schema do Header:

#	Pai	Campo	Descrição	Tipo	Ocorrências	Tamanho	Observação
1		CrosstalkHeader	Tag Raiz.	Grupo	1-1
2	1	EnterpriseId	Identificador da empresa emitente da mensagem.	GUID	1-1		Deve ser informando o identificador gerado pela Localização.
3	1	DestinationId	Identificador da empresa destinatário da mensagem.	GUID	0-1		Deve ser informando o identificador gerado pela Localização. Quando não informado será usado o EnterpriseId.
4	1	Token	Identificador do vínculo entre EnterpriseId e DestinationId.	GUID	1-1		Identificador de autorização que da permissão ao Destinatário receber a mensagem da Origem (vínculo entre EnterpriseId e DestinationId).
5	1	ProcessCode	Identificador do processo solicitado.	Número	1-1	5	Identifica o processo que irá processar a mensagem, neste caso deve ser informado: 25600.
6	1	MessageType	Identifica o tipo de mensagem enviada.	Número	1-1	3	Para este processo deve ser utilizado o valor: 100.
7	1	ExchangePattern	Padrão de troca de mensagens.	Número	1-1	1	7 = Requisição Assíncrona: Insere a requisição a ser processada; 8 = Resposta Assíncrona: Pesquisa o resultado do processamento de uma requisição anterior (deve ser usado o mesmo GUID da requisição a ser consultada).
8	1	Guid	Identificador único da mensagem.	GUID	0-1		Deve ser único para cada mensagem enviada. Se não for enviado o sistema gera um automaticamente.
9	1	ExecutionTime	Data e hora de envio e execução da mensagem.	Data/Hora	0-1		Formato: aaaa-mm-ddThh:mm:ss. Exemplo: 2015-12-01T10:32:52. Se não for enviada esta informação, será retornada a data e hora que o Web Service recebeu a requisição.
10	1	Encoding	Identifica o tipo de codificação do documento enviado.	Caractere	0-1		Identifica o tipo de codificação do documento enviado, por exemplo: utf-8, ASCII. Se essa informação não for enviada, será considerado uft-8.
11	1	ContentType	Identifica o tipo de conteúdo.	Caractere	0-1		Identifica o tipo de conteúdo que está sendo enviado. Para a Liberação de Embarque deve ser utilizado: text/plain
12	1	ResponseCode	Código de resposta do processamento, presente apenas nas mensagens de resposta.	Número	0-1	3	Será preenchido pela Localização na resposta da solicitação. Mensagens de Resposta.
13	1	ResponseMessage	Mensagem referente ao ResponseCode.	Caractere	0-1		Será preenchido pela Localização na resposta da solicitação. Mensagens de Resposta.

•RawData

Dentro do RawData deverão ser informadas as chaves dos documentos que compõem o embarque, conforme o schema: ShipmentRelease_ReceiveFrom_Taker especificado abaixo:

Exemplo XML da Liberação de Embarque:

<ShipmentRelease_ReceiveFrom_Taker Version="1.0.0" xsi:noNamespaceSchemaLocation="ShipmentRelease_ReceiveFrom_Taker.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

</Shipment>

</TaxDocument>

</TaxDocument>

</Release>

</ShipmentRelease_ReceiveFrom_Taker>

Detalhamento do Schema da Liberação de Embarque:

#	Pai	Campo	Descrição	Tipo	Ocorrências	Tamanho	Observação
1		ShipmentRelease_ReceiveFrom_Taker	TAG Raiz.	Grupo	1-1		No atributo "Version" informar o valor "1.0.0".
2	1	Release	Campos da Liberação de Embarque.	Grupo	1-1
3	2	Shipment	Grupo de informações para identificação do Shipment.	Grupo	1-1
4	3	DomainName	Domínio de dados do Embarcador no OTM.	Caractere	1-1		Nome do Domínio do Embarcador dentro do OTM.
5	3	XId	Identificador único do Shipment.	Caractere	1-1		Xid do Shipment no OTM.
6	2	PEF	Grupo de informações que indicam se o embarque é faturado.	Grupo	0-1		Grupo opcional, não utilizado nesta versão.
7	6	CIOT	Número do CIOT.	Caractere	1-1		Deve ser informado o Número do CIOT.
8	6	FreightValue	Valor do Frete.	Caractere	1-1		Deve ser informado o valor do Frete.
9	6	SingleParcel	Indica se a parcela de pagamento é única.	Caractere	1-1		True = Única parcela; False = Mais de uma parcela.
10	2	TaxDocument	Grupo para informar o documento que será vinculado ao embarque.	Grupo	0-N		Grupo que ira conter a Chave de Acesso a ser liberada para o Embarque.
11	10	AccessKey	Chave do Documento Fiscal.	Número	1-1	44	Chave do Documento Fiscal a ser vinculado ao embarque.
12	10	OrderRelease	Número do Pedido	caractere	0-1		Número do Pedido (se existir esta tag em uma das chaves a ser liberada, se torna obrigatorio informar em todas as demais)
13	10	Document	XML do Documento NFe	Caractere	0-1		XML da NFe a ser Liberada, nesta tag o documento e a Liberação de Embarque, podem ser enviadas na mesma Integração, pode ser utilizado NFe e ProcNFe.
14	2	IntegrationId	Identificador da integração.	Caractere	0-1		Não informar. Este campo é de uso interno da Localização.

Liberação de Embarque

Liberação de Embarque

voltar