Ir para o conteúdo

Agente de Carga

Próxima release.

Esta é a documentação da próxima release do Portal Único Siscomex. Ainda não se encontra disponível em produção, e podem haver diferenças entre esta documentação e a documentação da release atual. A documentação da release atual pode ser acessada em https://docs.portalunico.siscomex.gov.br/ .

Notificação push - Agente de Carga

A seguir estão especificados os eventos de interesse do agente de carga relacionados ao fluxo de negócio do CCT Importação.

Para ter acesso aos eventos, os interessados devem utilizar a API de notificação.

Bloqueio de AWB/MAWB

Notificação enviada quando um AWB/MAWB é bloqueado.

Identificador do evento: ccti-bloq-awbmawb

Exemplo de conteúdo enviado na notificação:

[
  {
    "numeroCarga": "000-000000000",
    "dataEmissao": "2021-01-31",
    "motivoBloqueio": "Sob análise da RFB",  
    "tipoBloqueio": "Impede entrega da carga ao importador"
  }
]

Campos enviados:

Nome Descrição Tipo Local
numeroCarga Número do Conhecimento de carga Texto(13) JSON
dataEmissao Data da Assinatura do transportador Texto(10) JSON
motivoBloqueio Nome do motivo de bloqueio de carga Texto(200) JSON
tipoBloqueio Nome do tipo de bloqueio de carga Texto(200) JSON

Desbloqueio de AWB/MAWB

Notificação enviada quando um AWB/MAWB é desbloqueado.

Identificador do evento: ccti-desbloq-awbmawb

Exemplo de conteúdo enviado na notificação:

[
  {
    "numeroCarga": "000-000000000",
    "dataEmissao": "2021-01-31",
    "motivoBloqueio": "Sob análise da RFB",  
    "tipoBloqueio": "Impede entrega da carga ao importador"
  }
]

Campos enviados:

Nome Descrição Tipo Local
numeroCarga Número do Conhecimento de carga Texto(13) JSON
dataEmissao Data da Assinatura do transportador Texto(10) JSON
motivoBloqueio Nome do motivo de bloqueio de carga Texto(200) JSON
tipoBloqueio Nome do tipo de bloqueio de carga Texto(200) JSON

Bloqueio de HAWB

Notificação enviada quando um HAWB é bloqueado.

Identificador do evento: ccti-bloq-hawb

Exemplo de conteúdo enviado na notificação:

[
  {
    "numeroCarga": "00000000",
    "dataEmissao": "2021-01-31",
    "cnpjResponsavelEnvioCriacao": "00000000000000",
    "motivoBloqueio": "Sob análise da RFB",  
    "tipoBloqueio": "Impede entrega da carga ao importador"
  }
]

Campos enviados:

Nome Descrição Tipo Local
numeroCarga Número do Conhecimento de carga Texto(35) JSON
dataEmissao Data da Assinatura do transportador Texto(10) JSON
cnpjResponsavelEnvioCriacao CNPJ do Responsável Texto(14) JSON
motivoBloqueio Nome do motivo de bloqueio de carga Texto(200) JSON
tipoBloqueio Nome do tipo de bloqueio de carga Texto(200) JSON

Desbloqueio de HAWB

Notificação enviada quando um HAWB é desbloqueado.

Identificador do evento: ccti-desbloq-hawb

Exemplo de conteúdo enviado na notificação:

[
  {
    "numeroCarga": "00000000",
    "dataEmissao": "2021-01-31",
    "cnpjResponsavelEnvioCriacao": "00000000000000",
    "motivoBloqueio": "Sob análise da RFB",  
    "tipoBloqueio": "Impede entrega da carga ao importador"
  }
]

Campos enviados:

Nome Descrição Tipo Local
numeroCarga Número do Conhecimento de carga Texto(35) JSON
dataEmissao Data da Assinatura do transportador Texto(10) JSON
cnpjResponsavelEnvioCriacao CNPJ do Responsável Texto(14) JSON
motivoBloqueio Nome do motivo de bloqueio de carga Texto(200) JSON
tipoBloqueio Nome do tipo de bloqueio de carga Texto(200) JSON

Inclusão de AWB/MAWB associado a viagem

Notificação enviada quando é incluído um AWB/MAWB associado a viagem.

Identificador do evento: ccti-incl-awbmawb-assoc-viag

Exemplo de conteúdo enviado na notificação:

[
  {
    "idAWBMAWB": "00000000", 
    "dataEmissaoAWBMAWB": "2021-01-31"
  }
]

Campos enviados:

Nome Descrição Tipo Local
idAWBMAWB Número do Conhecimento de carga Texto(35) JSON
dataEmissaoAWBMAWB Data de emissão do conhecimento de carga Texto(10) JSON

Retificação de AWB/MAWB associado a viagem

Notificação enviada quando é retificado um AWB/MAWB associado a viagem.

Identificador do evento: ccti-ret-awbmawb-assoc-viag

Exemplo de conteúdo enviado na notificação:

[
  {
    "idAWBMAWB": "00000000", 
    "dataEmissaoAWBMAWB": "2021-01-31"
  }
]

Campos enviados:

Nome Descrição Tipo Local
idAWBMAWB Número do Conhecimento de carga Texto(35) JSON
dataEmissaoAWBMAWB Data de emissão do conhecimento de carga Texto(10) JSON

Vinculação a documento de saída

Notificação enviada quando ocorre uma vinculação manual ou automática do conhecimento de carga/dsic a um documento de saída.

Identificador do evento: ccti-vinc-docto-saida

Exemplo de conteúdo enviado na notificação:

[
  {
    "tipoDocumentoSaida":"Outros (Protocolo)",
    "numeroDocumentoSaida":"111111111111111",
    "identificacaoCarga":"001-12345678",
    "dataEmissaoCarga":"01/01/2023 09:43 (UTC -03:00)",
    "cnpjResponsavelArquivoCarga": "00000000000000",
    "dataHoraVinculacao":"01/01/2023 14:21:54"
  }
]

Campos enviados:

Nome Descrição Tipo Local
tipoDocumentoSaida Tipo do documento de saída Texto(82) JSON
numeroDocumentoSaida Número do documento de saída Texto(17) JSON
identificacaoCarga Número do Conhecimento de carga Texto(13) JSON
dataEmissaoCarga Data da Assinatura do transportador Texto(10) JSON
cnpjResponsavelArquivoCarga CNPJ do Responsável pelo envio do conhecimento de carga Texto(14) JSON
dataHoraVinculacao Data da vinculação Texto(10) JSON

Desvinculação a documento de saída

Notificação enviada quando ocorre uma desvinculação manual ou automática do conhecimento de carga/dsic a um documento de saída.

Identificador do evento: ccti-desvinc-docto-saida

Exemplo de conteúdo enviado na notificação:

[
  {
   "tipoDocumentoSaida":"DTA",
   "numeroDocumentoSaida":"111111111111111",
   "identificacaoCarga":"001-12345678",
   "dataEmissaoCarga":"01/01/2023 09:43 (UTC -03:00)",
   "cnpjResponsavelArquivoCarga": "00000000000000",
   "dataHoraDesvinculacao ":"01/01/2023 14:21:54"
  }
]

Campos enviados:

Nome Descrição Tipo Local
tipoDocumentoSaida Tipo do documento de saída Texto(82) JSON
numeroDocumentoSaida Número do documento de saída Texto(17) JSON
identificacaoCarga Número do Conhecimento de carga Texto(13) JSON
dataEmissaoCarga Data da Assinatura do transportador Texto(10) JSON
cnpjResponsavelArquivoCarga CNPJ do Responsável pelo envio do conhecimento de carga Texto(14) JSON
dataHoraDesvinculacao Data da vinculação Texto(10) JSON

Inclusão/cancelamento de entrega intermediária

Notificação enviada quando ocorre uma inclusão ou cancelamento de uma entrega intermediária.

Identificador do evento: ccti-inc-entrega-interm

Exemplo de conteúdo enviado na notificação:

[
  {
   "tipoEvento":"Inclusão",
   "unidadeRFB":"717700",
   "cnpjEntregador":"00000000000000",
   "cnpjRecebedor":"11111111111111",
   "identificacaoCarga":"001-11111111",
   "dataEmissaoCarga":"01/01/2023 10:00 (UTC -03:00)",
   "cnpjResponsavelArquivoCarga":"22222222222222"
  }
]

Campos enviados:

Nome Descrição Tipo Local
tipoEvento Inclusão ou cancelamento Texto(12) JSON
unidadeRFB Código da unidade RFB Texto(7) JSON
cnpjEntregador CNPJ do entregador Texto(14) JSON
cnpjRecebedor CNPJ do recebedor Texto(14) JSON
identificacaoCarga Número do Conhecimento de carga Texto(35) JSON
dataEmissaoCarga Data da Assinatura do transportador Texto(29) JSON
cnpjResponsavelArquivoCarga CNPJ do Responsável Pelo envio do conhecimento de carga Texto(14)

Inclusão/cancelamento de entrega final

Notificação enviada quando ocorre uma inclusão ou cancelamento de uma entrega final.

Identificador do evento: ccti-inc-entrega

Exemplo de conteúdo enviado na notificação:

[
  {
   "tipoEvento":"Inclusão",
   "unidadeRFB":"0717700",
   "recintoAduaneiro":"7911101",
   "tipoDocSaida":"Outros",
   "numeroDocSaida":"333333333333333",
   "identificacaoCarga":"001-11111111",
   "dataEmissaoCarga":"01/01/2023 10:00 (UTC -03:00)",
   "cnpjResponsavelArquivoCarga":"00000000000000"
  }
]

Campos enviados:

Nome Descrição Tipo Local
tipoEvento Inclusão ou cancelamento Texto(12) JSON
unidadeRFB Código da unidade RFB da entrega Texto(7) JSON
recintoAduaneiro Código do recinto aduaneiro da entrega Texto(7) JSON
tipoDocSaida Tipo de documento de saída Texto(60) JSON
numeroDocSaida Número do documento de saída Texto(20) JSON
identificacaoCarga Número do Conhecimento de carga Texto(35) JSON
dataEmissaoCarga Data da Assinatura do transportador Texto(29) JSON
cnpjResponsavelArquivoCarga CNPJ do Responsável Pelo envio do conhecimento de carga Texto(14)

Inclusão/cancelamento/retificação de recepção

Notificação enviada quando ocorre uma inclusão, cancelamento ou retificação de uma recepção.

Identificador do evento: ccti-inc-recepcao

Exemplo de conteúdo enviado na notificação:

[
  {
   "tipoEvento":"Inclusão",
   "unidadeRFB":"0717700",
   "recintoAduaneiro":"7911101",
   "identificacaoCarga":"001-11111111",
   "dataEmissaoCarga":"01/01/2023 10:00 (UTC -03:00)",
   "cnpjResponsavelArquivoCarga":"00000000000000"
  }
]

Campos enviados:

Nome Descrição Tipo Local
tipoEvento Inclusão ou cancelamento Texto(12) JSON
unidadeRFB Código da unidade RFB da entrega Texto(7) JSON
recintoAduaneiro Código do recinto aduaneiro da entrega Texto(7) JSON
identificacaoCarga Número do Conhecimento de carga Texto(35) JSON
dataEmissaoCarga Data da Assinatura do transportador Texto(29) JSON
cnpjResponsavelArquivoCarga CNPJ do Responsável pelo envio do conhecimento de carga Texto(14) JSON

Retificação do estoque

Notificação enviada quando ocorre uma retificação do estoque.

Identificador do evento: ccti-inc-ret-estoque

Exemplo de conteúdo enviado na notificação:

[
  {
   "unidadeRFB":"717700",
   "recintoAduaneiro":"7919901",
   "cnpjResponsavelAtual":"22222222222222",
   "identificacaoCarga":"001-11111111",
   "dataEmissaoCarga":"01/01/2023 10:00 (UTC -03:00)",
   "cnpjResponsavelArquivoCarga":"00000000000000"
  }
]

Campos enviados:

Nome Descrição Tipo Local
unidadeRFB Código da unidade RFB da entrega Texto(7) JSON
recintoAduaneiro Código do recinto aduaneiro da entrega Texto(7) JSON
cnpjResponsavelAtual CNPJ do responsável atual pelo estoque Texto(14) JSON
identificacaoCarga Número do Conhecimento de carga Texto(35) JSON
dataEmissaoCarga Data da Assinatura do transportador Texto(29) JSON
cnpjResponsavelArquivoCarga CNPJ do Responsável pelo envio do conhecimento de carga Texto(14) JSON