Como este processo é assíncrono, após enviar a Mensagem solicitando a Consulta ao Status do Embarque, é necessário solicitar a resposta desse processamento com o status do embarque pesquisado.
Para solicitar o retorno dos documentos, é necessário fazer uma chamada ao Web Service, informando no CrosstalkHeader o GUID que foi retornado na solicitação de download e o valor 8 no campo ExchangePattern.
Conforme informado no item, Consulta Status do Embarque, para consulta ao Status do Embarque, deve-se usar o Método Send.
Os Status do Embarque estarão dentro do campo shipmentData, do schema: Search_ShipmentERPIntegration_Response especificado abaixo:
•Search_ShipmentERPIntegration_Response
Exemplo do retorno Search_ShipmentERPIntegration_Response
<Search_ShipmentERPIntegration_Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RequestResponse> <Code></Code> <Message></Message> <Description></Description> </RequestResponse> <Shipment> <ShipmentId> <DomainName></DomainName> <XId></XId> </ShipmentId> <ShipmentData> <Details> <CarrierCnpj></CarrierCnpj> <TakerCnpj></TakerCnpj> <TotalPlannedCost></TotalPlannedCost> <ShipmentCost> <Xid></Xid> <MonetaryAmount></MonetaryAmount> <IsWeighted></IsWeighted> </ShipmentCost> <Status></Status> <ShipmentRelease> <ReleaseDate> </ReleaseDate> <IntegrationId></IntegrationId> <NFeDocument> <AccessKey></AccessKey> <Serie></Serie> <Number></Number> <EmissionDate></EmissionDate> <OrderRelease></OrderRelease> </NFeDocument> </ShipmentRelease> <TransportDocument> <CTeData> <AccessKey></AccessKey> <Serie></Serie> <Number></Number> <EmissionDate></EmissionDate> <ServiceCost></ServiceCost> <ReceiveValue></ReceiveValue> <Source></Source> <Destination></Destination> <Status></Status> <PaymentStatus></PaymentStatus> </CTeData> </TransportDocument> </Details> </ShipmentData> </Shipment> </Search_ShipmentERPIntegration_Response> |
Detalhamento do schema de retorno Search_ShipmentERPIntegration_Response
# |
Pai |
Campo |
Descrição |
Tipo |
Ocorrências |
Tamanho |
Observação |
|---|---|---|---|---|---|---|---|
1 |
|
Search_ShipmentERPIntegration_Response |
TAG Raiz. |
Grupo |
1-1 |
|
|
2 |
1 |
RequestResponse |
Grupo com as informações da resposta da solicitação. |
Grupo |
1-1 |
|
|
3 |
2 |
Code |
Código da mensagem do processamento. |
Número |
1-1 |
3 |
100 = Solicitação processada com sucesso; 200 = Schema XML de solicitação está incorreto; 201 = Usuário ou senha inválidos; 202 = Bloco solicitado sem documentos relacionados para o usuário. |
4 |
2 |
Message |
Mensagem referente ao código de resposta. |
Caractere |
1-1 |
|
|
5 |
2 |
Description |
Mensagem específica de alguma falha no processamento. |
Caractere |
0-1 |
|
|
6 |
1 |
Shipment |
Grupo com as informações do Shipment encontrado. |
Grupo |
1..N |
|
|
7 |
6 |
Shipmentid |
Grupo com as informações de identificação do shipment |
Grupo |
1-1 |
|
|
8 |
7 |
DomaninName |
Nome de Domínio do OTM. |
Caractere |
1-1 |
|
|
9 |
7 |
XId |
Identificador do Shipment. |
Caractere |
1-1 |
|
|
10 |
6 |
ShipmentData |
Grupo com as informações do Shipment. |
Grupo |
1-1 |
|
|
11 |
10 |
Inconsistency |
Grupo com informações sobre possíveis inconsistências no shipment. |
Grupo |
1..N |
|
Se esta Tag for informada, a tag details não deve aparecer. |
12 |
10 |
Details |
Grupo de contém as informações sobre o Shipment |
Grupo |
1-1 |
|
Se esta Tag for informada, a Tag Inconsistency nao deve aparecer. |
13 |
12 |
CarrierCnpj |
Cnpj do Transportador. |
Número |
1-1 |
14 |
Cnpj do Transportador do Embarque. |
14 |
12 |
TakerCnpj |
Cnpj do Embarcado. |
Número |
1-1 |
14 |
Cnpj do Embarcador. |
15 |
12 |
TotalPlannedCost |
Valor Total planejado no Shipment. |
Caractere |
1-1 |
|
Valor Total planejado no Shipment. |
16 |
12 |
ShipmentCost |
Detalhamento dos custos do Shipment |
Grupo |
0-1 |
|
Detalhamento dos custos do Shipment |
17 |
16 |
Xid |
Identificador do tipo de custo |
Caractere |
1-1 |
|
Identificador do tipo de custo. |
18 |
16 |
MonetaryAmount |
Valor do custo |
Número |
1-1 |
|
Valor do custo |
19 |
16 |
IsWeighted |
Identifica se o custo é do tipo "Ponderado" |
Caractere |
1-1 |
|
Quando o tipo for ponderado, o valor não será somado no valor total do Shipment. |
20 |
12 |
Status |
Informa o Status dos documentos da Liberação de Embarque. |
Número |
1-1 |
1 |
1 = Aguardando Liberação; 2 = Disponível para download; 3 = Download Efetuado. |
21 |
12 |
ShipmentRelease |
Grupo com as informações sobre a liberação de Embarque. |
Grupo |
0-1 |
|
|
22 |
21 |
ReleaseDate |
Data e hora da Liberação do Embarque. |
Caractere |
1-1 |
|
|
23 |
21 |
IntegrationId |
Identificador da Integração, Número da integração. |
Caractere |
0-1 |
|
|
24 |
21 |
NFeDocument |
Grupo com as informações dos documentos fiscais do Embarque. |
Grupo |
0..N |
|
|
25 |
24 |
AccessKey |
Chave de acesso do documento Fiscal do Embarque. |
Número |
1-1 |
44 |
|
26 |
24 |
Serie |
Série do documento Fiscal do Embarque. |
Número |
1-1 |
3 |
|
27 |
24 |
Number |
Número do documento Fiscal do Embarque. |
Número |
1-1 |
9 |
|
28 |
24 |
EmissionDate |
Data de Emissão do Documento. |
Caractere |
1-1 |
|
|
29 |
24 |
OrderRelease |
Número do Pedido que foi enviado para o documento na Liberação do embarque. |
Caractere |
0-1 |
|
|
30 |
24 |
POD |
Dados da Prova de Entrega. |
Grupo |
0-1 |
|
Esta TAG só será informada, caso a NFe possua POD. |
31 |
30 |
DeliveryDate |
Indica a data de entrega informada pelo transportador para o POD. |
Caractere |
1-1 |
|
|
32 |
30 |
Note |
Caso o Transportador tenha informado alguma Observação para a entrega, estara nesta TAG. |
Caractere |
0-1 |
|
|
33 |
30 |
ApprovalDate |
Data da aprovação do POD pelo Embarcador. |
Caractere |
0-1 |
|
Se Esta TAG for Informada significa que o POD foi Aprovado pelo Embarcador, Caso Não seja informado nenhuma das Tags: ApprovalDate ou RejectionDate, significa que o POD esta com status = "Aguardando Aprovação" |
34 |
30 |
RejectionDate |
Data da Rejeição do POD pelo Embarcador. |
Caractere |
0-1 |
|
Se Esta TAG for Informada significa que o POD foi Rejeitado pelo Embarcador, Caso Não seja informado nenhuma das Tags: ApprovalDate ou RejectionDate, significa que o POD esta com status = "Aguardando Aprovação" |
35 |
30 |
RejectionReason |
Motivo da Rejeição informado pelo Embarcador. |
Caractere |
0-1 |
|
|
36 |
12 |
TransportDocument |
Grupo com os documentos Fiscais do Transporte. |
Grupo |
0-N |
|
|
37 |
36 |
CTeData |
Grupo com ais informações dos CTes. |
Grupo |
1-1 |
|
|
38 |
37 |
AccessKey |
Chave de acesso do CTe. |
Número |
1-1 |
44 |
|
39 |
37 |
Serie |
Série do documento Fiscal do Transporte. |
Número |
1-1 |
3 |
|
40 |
37 |
Number |
Número do documento Fiscal do Transporte. |
Número |
1-1 |
|
|
41 |
37 |
EmissionDate |
Data de Emissão do Documento. |
Caractere |
1-1 |
|
|
42 |
37 |
ServiceCost |
Valor total do CTe. |
Caractete |
1-1 |
9 |
|
43 |
37 |
ReceiveValue |
Valor a receber. |
Caractere |
1-1 |
|
|
44 |
37 |
Source |
Nome do Emitente do Documento. |
Caractere |
1-1 |
||
45 |
37 |
Destination |
Nome do Destinatário do Documento. |
Caractere |
1-1 |
||
46 |
37 |
Status |
Status do Documento. |
Número |
1-1 |
1 |
1 = Autorizado; 2 = Rejeitado; 3 = Cancelado; |
47 |
37 |
PaymentStatus |
Status do pagamento. |
Número |
1-1 |
1 |
1 = Rejeitado; 2 = Aguardando Aprovação Manual; 3 = Disponível para Pagamento; 4 = Incluso em Fatura; |