A integração disponibilizada para busca de pacote de Fatura trata, em um processo assíncrono, a captura de um documento específico solicitado no momento da requisição ao serviço de integração do nddFrete. Para isso, é necessário informar na chamada de solicitação do documento, o identificador do Pacote de Fatura que se deseja obter. Este identificador deve ter sido retornado previamente através da Consulta Lista de Faturas.
Ao receber a lista de identificadores, a aplicação nddFrete localiza em sua base de dados o documento relacionado a cada pacote, processa-os, monta a mensagem de reposta e marca os documentos como consumidos. Os documentos processados são retornados na busca da resposta da primeira requisição.
Crosstalk de Envio |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4010</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>7</ExchangePattern> <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId> <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> </CrosstalkHeader> </CrosstalkMessage> |
Detalhamento do Crosstalk |
|---|
# |
ID |
Campo |
Descrição |
Pai |
Tipo |
Ob. |
1 |
RAIZ |
CrossTalk_Message |
Tag raiz da mensagem |
- |
- |
S |
2 |
A01 |
CrossTalk_Header |
Cabeçalho |
RAIZ |
- |
S |
3 |
B01 |
ProcessCode |
Código da mensagem marcação de documentos: o4010 - Busca dos pacotes de Fatura |
A01 |
N |
S |
4 |
B02 |
MessageType |
Tipo da operação: o103 |
A01 |
N |
S |
5 |
B03 |
ExchangePattern |
TIpo da mensagem: o7 (assíncrona) o8 (assíncrona) |
A01 |
N |
S |
6 |
B04 |
GUID |
Identificador da mensagem |
A01 |
GUID |
N (Apenas na consulta do processamento) |
7 |
B04 |
EnterpriseId |
Identificador do operador logístico ou do Cliente |
A01 |
GUID |
S |
8 |
B05 |
Token |
Token para autenticação operador logístico |
A01 |
GUID |
S |
9 |
B06 |
ContentType |
Formato da mensagem enviada: otext/xml |
A01 |
C |
S |
Solicitação de Pacote |
<DataRequest Version= "1.0"> <Id>FATURA_65849838002577_59275792002799_4_2</Id> </DataRequest> |
Detalhamento da Consulta |
# |
ID |
Campo |
Descrição |
Pai |
Tipo |
Ob. |
1 |
RAIZ |
DataRequest |
Tag raiz da mensagem |
- |
- |
S |
2 |
A01 |
Id |
Identificador do Pacote |
RAIZ |
- |
S |
Retorno de Envio |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4010</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>7</ExchangePattern> <Guid>3e58e8ab-b63f-444a-bda1-c390b1b8915b</Guid> <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId> <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> <ResponseCode>200</ResponseCode> <ResponseMessage>A mensagem foi recebida e está sendo processada.</ResponseMessage> </CrosstalkHeader> </CrosstalkMessage> |
O retorno obtido na primeira requisição do processo assíncrono, informa se a mensagem foi processada com sucesso. Caso a mensagem enviada não possua as tags obrigatórias será retornado falha de schema. Se algum dos campos obrigatórios não estiver no formato correto, a mensagem de retorno criticará o mesmo. |
Consulta do Processamento |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4009</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>8</ExchangePattern> <Guid>3e58e8ab-b63f-444a-bda1-c390b1b8915b</Guid> <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId> <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> </CrosstalkHeader> </CrosstalkMessage> |
A consulta com o ExchangePattern 8 retorna se a solicitação foi processada ou ainda está em processamento.
Retorno do Processamento |
|---|
<CrosstalkMessage> <CrosstalkHeader> <ProcessCode>4010</ProcessCode> <MessageType>103</MessageType> <ExchangePattern>7</ExchangePattern> <Guid>237051b2-5d80-4063-81ba-22f3c0ac0053</Guid> <EnterpriseId>43abeae4-7786-4017-a4ea-a8f54efd0e4a</EnterpriseId> <Token>6901a7fb-f545-c9a1-4ebd-18a723329dfb</Token> <ContentEncoding>UTF-8</ContentEncoding> <ContentType>txt/xml</ContentType> <ResponseCode>205</ResponseCode> <ResponseMessage>A mensagem foi processada com sucesso.</ResponseMessage> </CrosstalkHeader> <CrosstalkBody> <RawData><![CDATA[<DataResponse Version="1.0"><Element><Id>_65849838002577_59275792002799_7_5</Id><Data>000 1501181122COB501501000 550COBRA501501001 55100000000000000 552 05 00000000071512201715122017000000000000009BCO00000000000000000000000000000000000000000000000 0000 0000000000 I 00000000000000000000 000000000 555 10 00000000069900000000000000915122017000000000000000000000000000000000000000000 N 5590001000000000000009 </Data></Element></DataResponse>]]></RawData> </CrosstalkBody> </CrosstalkMessage> |
Códigos Retorno do Cabeçalho da Mensagem |
|---|
Código |
Mensagem |
Situação |
203 |
A mensagem foi rejeitada por causa de falha na validação do esquema do documento |
Estrutura do xml de envio incorreta. |
205 |
A mensagem foi processada com sucesso. |
Processo de retorno da lista executado com sucesso. |
207 |
A mensagem foi rejeitada porque a mensagem já existe na base de dados. |
O GUID da mensagem já existir na aplicação nddFrete. |
210 |
ProcessCode e MessageType inválido. |
O ProcessCode ou o MessageType informados não existem na aplicação nddFrete. |
218 |
A mensagem foi rejeitada porque o operador logístico não está cadastrado. |
O EnterpriseId e o Token informado não existem na aplicação nddFrete. |
220 |
A quantidade de identificadores é maior que o limite de pacotes configurado. |
Número de pacotes solicitados excede ao tamanho configurado para retorno na requisição. |
999 |
Ocorreu um erro inesperado no processamento da mensagem. |
Erro não catalogado. |
Códigos de Erro no Retorno do Corpo da Mensagem |
|---|
Código |
Mensagem |
Situação |
404 |
Identificador não encontrado |
Identificador informado na mensagem não existe na base de dados ou, solicitante não possui permissão para consumir o pacote. |
405 |
Erro na execução do mapeamento:{xxx} |
Possíveis erros retornados da transformação do documento. |