Esta integração visa Consultar o Status dos Embarques enviados pela Embarcadora, o envio da consulta é realizado de forma assíncrona, sendo necessário realizar a consulta do resultado do processamento usando o mesmo GUID informado no envio da solicitação. Serão disponibilizadas as informações vinculadas ao número do embarque consultado, retornando informações como: CNPJ do Embarcador, CNPJ do Transportador, custo total e acessório, data de liberação e documentos vinculados ao Embarque.
Para envio da Consulta a status de Embarque deverá ser utilizado o método abaixo:
•Send
A postagem da Consulta a status 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> <ProcessCode></ProcessCode> <MessageType></MessageType> <ExchangePattern></ExchangePattern> <EnterpriseId></EnterpriseId> <Token></Token> <Guid></Guid> </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: 25602. |
6 |
1 |
MessageType |
Identifica o tipo de mensagem enviada. |
Número |
1-1 |
3 |
Para este processo deve ser utilizado o valor: 103. |
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. Para isso, deve ser informado o GUID retornado na requisição anterior. |
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 informados os dados do Embarque a ser consultado, conforme o schema: Search_ShipmentERPIntegration_Request especificado abaixo:
Exemplo XML da Consulta de Embarque:
<Search_ShipmentERPIntegration_Request Version="1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Authentication IsHash="0"> <UserName></UserName> <Password></Password> </Authentication> <Filter> <ShipmentId> <DomainName></DomainName> <XId></XId> </ShipmentId> <NFeDocument> <AccessKey></AccessKey> </NFeDocument> </Filter> </Search_ShipmentERPIntegration_Request> |
|---|
Detalhamento do Schema da Consulta Status do Embarque:
# |
Pai |
Campo |
Descrição |
Tipo |
Ocorrências |
Tamanho |
Observação |
|---|---|---|---|---|---|---|---|
1 |
|
Search_ShipmentERPIntegration_Request |
TAG Raiz. |
Grupo |
1-1 |
|
No atributo "Version" informar o valor "1.0.0". |
2 |
1 |
Authentication |
Dados de autenticação. |
Grupo |
1-1 |
|
No atributo "IsHash" informar os valores: - "0" = Informar Senha Descriptografada; - "1" = informar Senha Criptografada. |
3 |
2 |
UserName |
Nome do usuário. |
Caractere |
1-1 |
|
Nome do usuário. |
4 |
2 |
Password |
Senha de acesso ao sistema. |
Caractere |
1-1 |
|
Senha de acesso ao sistema. |
5 |
1 |
Filter |
Filtros a serem aplicados. |
Grupo |
1-1 |
|
Filtros a serem aplicados. |
6 |
5 |
ShipmentId |
Identificador do shipment release. |
Grupo |
1-1 |
|
Identificador do shipment release. Se utilizado, não informar grupo NFeDocument. |
7 |
6 |
DomainName |
Domínio de dados do Identificador. |
Caractere |
1-1 |
|
Domínio de dados do Identificador. |
8 |
6 |
XId |
Identificador único dentro do domínio de dados. |
Caractere |
1-1 |
|
Identificador único dentro do domínio de dados. |
9 |
5 |
NFeDocument |
Documento fiscal do embarque. |
Grupo |
1-1 |
|
Documento fiscal do embarque. Se utilizado, não informar grupo ShipmentId. |
10 |
9 |
AccessKey |
Chave de acesso do NFe. |
Caractere |
1-1 |
44 |
Chave de acesso do NFe. |