Integra Comex - Carga Marítima API Reference

Para tornar o acesso aos sistemas governamentais mais eficiente e inteligente, estamos disponibilizando o barramento de serviços Integra Comex.

O Integra Comex permite aos Operadores de Comércio Exterior se integrarem diretamente às bases governamentais que controlam operações de importação, exportação e gestão de cargas.

O principal ganho deste barramento é permitir consultas orientadas por operação, isto é, todas as informações relacionadas a uma determinada operação serão retornadas em uma única consulta, agregando informações que hoje estão fragmentadas em diversos sistemas e consultas.

As consultas classificam-se em dois grupos: Pública e Restrita.

Pública: A visibilidade é Irrestrita pois não possui sigilo comercial e fiscal.
Será disponibilizado a “data da última alteração” vinculada ao Conhecimento de Transporte Marítimo (CE-Mercante), Manifesto e Escala. As alterações poderão ser motivadas por​​inclusões​​e ​alterações​​na basedos sistemas Mercante e Siscomex Carga. Não é objetivo desta API indicaro motivo da alteração e sim indicar que alguma informação foi alteradanaquela data/hora. Documentação disponível em
https://siscomex-carga.estaleiro.serpro.gov.br/siscarga-api/

Restrita: A visibilidade é restrita pois possui informações com sigilo comercial e fiscal. O acesso será via certificado digital (e-CPF) e credenciais API Serpro que são disponibilizadas após contratação. A obrigatoriedade da utilização do certificado digital e-CPF obedece o padrão de acesso aos sistemas da família Siscomex e estão baseadas na resolução CTIC/MF N°10 de 10/08/2017. A presente documentação trata destas consultas classificadas como restritas.

Para testar o ambiente de validação, acesse a documentação técnica de apoio em https://atendimento.serpro.gov.br/integracomex/documentacao

Autenticação


As APIs disponibilizadas pela plataforma API Serpro utilizam o protocolo Oauth2 para realizar a autenticação e autorização de acesso das APIs contratadas.

Fase Contratual - Realizada para obter as credenciais de acesso
Para consumir as APIs, é necessário utilizar as credenciais de acesso (Consumer Key e Consumer Secret) disponibilizados no portal do Cliente. Esses códigos servem para identificar o contrato. Exemplos de código:

Consumer Key: djaR21PGoYp1iyK2n2ACOH9REdUb
Consumer Secret: ObRsAJWOL4fv2Tp27D1vd8fB3Ote

Para garantir a irretratabilidade (não repúdio), o portal do cliente exigirá o certificado digital e-CNPJ (cadeia ICP Brasil) da contratante para visualizar essas credenciais de acesso.

Fase Operacional
Consumo da API - Token de Acesso (Bearer)
Para consultar as APIs disponibilizadas pelo SERPRO, é necessário obter um Token de Acesso Temporário (Bearer). Esse token possui um tempo de validade e sempre que expirado, este passo de requisição de um novo token de acesso deve ser repetido.
Para solicitar o token temporário é necessário realizar uma requisição HTTP POST para o endpoint URL_BASE_AUTENTICACAO/authenticate com as seguintes características:
a) Certificado Digital e-CPF padrão ICP-Brasil válido;
b) HTTP Header:
b.1) Authorization: Basic (base64(consumerKey:consumerSecret)) - Credenciais de acesso (consumerKey:consumerSecret) no HTTP Header Authorization, no formato base64
b.2) "role-type": "IMPEXP"
b.3) "content-type": "application/json"

Por exemplo:
"request":{
"method": "POST",
"headers":{
"authorization": "Basic NlhvWUlEUjIybWhrMWJlcV9kcVczMVR4NlhzYTpQSWk5YmdwVzJWczhUTkdLcFowTzZ4cHBGOEFh",
"role-type": "IMPEXP",
"content-type": "application/json"
},
"uri": "${\"URL_SAPI\"}"
}


O retorno da autenticação será um token temporário para ser utilizado no consumo dos serviços. Esse token temporário é composto por

{ "expires_in": 2008, "scope": "am_application_scope default", "token_type": "Bearer", "access_token": "ce6112ab644f06a31b238fe9739f38a4", "jwt_token": "eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIwMDA0
ODc0NzQ5MSIsInRpcG8iOiJQRiIsImFjY2VzcyI6ImNlNjExMmF
iNjQ0ZjA2YTMxYjIzOGZlOTczOWYzOGE0IiwiaXAiOiIxMC4zNC
4yMDUuMTA3Iiwicm9sZXMiOlt7ImlkIjoiSU1QRVhQIiwiZGVzY
yI6IkltcG9ydGFkb3JcL0V4cG9ydGFkb3IiLCJ0cmFucyI6WyJE
RUZBVUxUIl19XSwiaXNzIjoiU0FQSSIsImNwZiI6IjAwMDQ4NzQ
3NDkxIiwibm9tZSI6IjAwMDQ4NzQ3NDkxIC0gSE9NT0xPR0FDQU
8iLCJleHAiOjE1NzM2NzQ4OTEsImlhdCI6MTU3MzY3Mjg4MywiZ
GVzYyI6IjAwMDQ4NzQ3NDkxIC0gSE9NT0xPR0FDQU8ifQ.RjgRh
VSxzJ1eEtz5ZlQbUc8qI3bZhSY7IkBXakYJbv-8-B_fECVJ346a
tkY4zKhOAi3mAu_S5CsbEUe6wWTkAFNycudkn29ZvLFELvdvKLN
4-IXs8p6jP8i1rexFPy-LqhL0_gdiFTExi_mXqw3Q1rIInu3BW5
YmYTLfHWgrrp0O6tZScPRj6d-MCjvWPXItWOWgGiRF8LFhQEPv3
QzaYfT05HHbhD_IQDtbec5AtPM0rdiNVXVk1M7JPrbE1mVaP9Ur
3e7cajrip-yTTTwPJj9w4MCQ1zmK9lgfO9YeS9iKf7fZpik2JXp
hafedbPlScgFAcV5rT-j6N3-ArHM5Jw" }

Onde:

expires_in: Tempo para expirar o token temporário Integra Comex;

scope: Escopo padrão;

token_type: Classifica o tipo de token temporário;

acess_token: Gerado com base nas credenciais contratuais da API Serpro, disponíveis na área do cliente mediante e-CNPJ.
Possui controle de expiração por parte do plataforma API Serpro.

jwt_token: Seu objetivo é prover uma comunicação eficiente e leve entre API’s e microservices e armazena conteúdo do certificado digital do usuário. O JWT é um padrão (RFC-7519) de mercado que define como transmitir e armazenar objetos JSON de forma compacta e segura entre diferentes aplicações. Os dados nele contidos podem ser validados a qualquer momento pois o token é assinado digitalmente pela própria aplicação Integra Comex e não pode alterado. A cada requisição isso é verificado. Caso ocorra uma falsificação do JWT, a assinatura ficará inválida e o JWT rejeitado. No JWT estará contido o e-CPF do usuário, onde ele será usando para acesso autorizado às informações via representação Siscomex. Ao acionar o serviço de autenticação, será preciso realizar o processo de handshake SSL entre a aplicação cliente e o Integra Comex, apresentando um certificado digital e-CPF A1 ou A3, padrão ICP-Brasil. Essa é a atual solução adotada pelo Portal Único do Comércio Exterior, detalhada no endereço: https://val.portalunico.siscomex.gov.br/docs/api/#introducao.

URL_BASE_AUTENTICACAO
Validação:
https://hom-siscomex-sapi.estaleiro.serpro.gov.br/authenticate
Produção:
https://siscomex-sapi.estaleiro.serpro.gov.br/authenticate
URL_BASE_INTEGRA_COMEX
Validação:
https://gateway.apiserpro.serpro.gov.br/integra-comex-carga-hom/v1
Produção:
https://gateway.apiserpro.serpro.gov.br/integra-comex/api

itens

itens

Consultar dados dos itens de conhecimento de embarque.

GET /conhecimentos-embarque/{nr-ce}/itens/

Consulta dados dos itens do conhecimento de embarque informado no PathVariable. Quando o número de itens exceder a capacidade de retorno em uma requisição, o response irá disponibilizar o atributo 'links' contendo o link para recuperação da próxima página (rel-next) e o link que deu origem à resposta (rel-self).

Exemplo do header 'links' com informações de paginação no response: "links": URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000109286/itens/; rel="self" , URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000109286/itens/0001; rel="next"

Exemplo: URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000018565/itens/

Authorization: string
in header

Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. 'Bearer '

jwt_token: string
in header

Token JWT fornecido pelo serviço de autenticação (SAPI)

nr-ce: string
in path

Número do Conhecimento de Embarque. O número não será validado e a api só retornará o encontrado.

200 OK
Item

OK

400 Bad Request
Error

Requisição mal formada.

403 Forbidden
Error

Usuário não tem permissão para acessar o recurso solicitado

404 Not Found
Error

Recurso Não encontrado

422 Unprocessable Entity
Error

Erro de negócio

500 Internal Server Error
Error

Erro inesperado

Response Content-Types: application/json;charset=UTF-8
Response Example (200 OK) 
{
  "cargasSoltas": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "101-23",
      "codigoMercadoriaPerigosa": "102-23",
      "contraMarca": "IHC DO BRASIL",
      "cubagem": "10.00",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "inEmbalagemMadeira": false,
      "marca": "IHC DO BRASIL",
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "operacaoCodigoRA": "string",
      "operacaoData": "string (date-time)",
      "operacaoDescricao": "string",
      "pesoBruto": "10000.000",
      "quantidade": "50",
      "tipoEmbalagem": "PALLET"
    }
  ],
  "conteineres": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "4.1",
      "codigoMercadoriaPerigosa": "1325",
      "cubagem": "54.000",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "identificacao": "CAIU4974474",
      "inEmbalagemMadeira": false,
      "lacre": [
        "string"
      ],
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "operacaoCodigoRA": "string",
      "operacaoData": "string (date-time)",
      "operacaoDescricao": "string",
      "pesoBruto": "3700.000",
      "tara": "3700.000",
      "tipo": "45G0",
      "tipoConteiner": "45G0",
      "usoParcial": false
    }
  ],
  "graneis": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "1012",
      "codigoMercadoriaPerigosa": "102-23",
      "cubagem": "1000.000",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "inEmbalagemMadeira": false,
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "pesoBruto": "1000000.000"
    }
  ]
}
Response Example (400 Bad Request) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (403 Forbidden) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (404 Not Found) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (422 Unprocessable Entity) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (500 Internal Server Error) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
itens

Consultar dados dos itens de conhecimento de embarque.

GET /conhecimentos-embarque/{nr-ce}/itens/{nr-item}

Consulta dados dos itens do conhecimento de embarque informado no PathVariable. Quando o número de itens exceder a capacidade de retorno em uma requisição, o response irá disponibilizar o atributo 'links' contendo o link para recuperação da próxima página (rel-next) e o link que deu origem à resposta (rel-self).

Exemplo do header 'links' com informações de paginação no response: "links": URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000109286/itens/0001; rel="self" , URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000109286/itens/0001; rel="next"

Exemplo:URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000018565/itens/0021

Authorization: string
in header

Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. 'Bearer '

jwt_token: string
in header

Token JWT fornecido pelo serviço de autenticação (SAPI)

nr-ce: string
in path

Número do Conhecimento de Embarque. O número não será validado e a api só retornará o encontrado.

nr-item: string
in path

Número do item inicial para recuperar informações no Conhecimento de Embarque. Se não for preenchido, o primeiro item existente no CE será utilizado como item inicial.

200 OK
Item

OK

400 Bad Request
Error

Requisição mal formada.

403 Forbidden
Error

Usuário não tem permissão para acessar o recurso solicitado

404 Not Found
Error

Recurso Não encontrado

422 Unprocessable Entity
Error

Erro de negócio

500 Internal Server Error
Error

Erro inesperado

Response Content-Types: application/json;charset=UTF-8
Response Example (200 OK) 
{
  "cargasSoltas": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "101-23",
      "codigoMercadoriaPerigosa": "102-23",
      "contraMarca": "IHC DO BRASIL",
      "cubagem": "10.00",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "inEmbalagemMadeira": false,
      "marca": "IHC DO BRASIL",
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "operacaoCodigoRA": "string",
      "operacaoData": "string (date-time)",
      "operacaoDescricao": "string",
      "pesoBruto": "10000.000",
      "quantidade": "50",
      "tipoEmbalagem": "PALLET"
    }
  ],
  "conteineres": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "4.1",
      "codigoMercadoriaPerigosa": "1325",
      "cubagem": "54.000",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "identificacao": "CAIU4974474",
      "inEmbalagemMadeira": false,
      "lacre": [
        "string"
      ],
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "operacaoCodigoRA": "string",
      "operacaoData": "string (date-time)",
      "operacaoDescricao": "string",
      "pesoBruto": "3700.000",
      "tara": "3700.000",
      "tipo": "45G0",
      "tipoConteiner": "45G0",
      "usoParcial": false
    }
  ],
  "graneis": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "1012",
      "codigoMercadoriaPerigosa": "102-23",
      "cubagem": "1000.000",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "inEmbalagemMadeira": false,
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "pesoBruto": "1000000.000"
    }
  ]
}
Response Example (400 Bad Request) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (403 Forbidden) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (404 Not Found) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (422 Unprocessable Entity) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (500 Internal Server Error) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}

conhecimentos-embarque

conhecimentos-embarque

Consultar dados do conhecimento de embarque.

GET /conhecimentos-embarque/{nr}

Consulta dados de conhecimento de embarque passado no PathVariable. Exemplo: URL_BASE_INTEGRA_COMEX/conhecimentos-embarque/131905000018565

Authorization: string
in header

Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. 'Bearer '

jwt_token: string
in header

Token JWT fornecido pelo serviço de autenticação (SAPI)

nr: string
in path

Número do Conhecimento de Embarque. O número não será validado e a api só retornará o encontrado.

200 OK
Conhecimento embarque

OK

400 Bad Request
Error

Requisição mal formada.

403 Forbidden
Error

Usuário não tem permissão para acessar o recurso solicitado

404 Not Found
Error

Recurso Não encontrado

422 Unprocessable Entity
Error

Erro de negócio

500 Internal Server Error
Error

Erro inesperado

Response Content-Types: application/json;charset=UTF-8
Response Example (200 OK) 
{
  "afrmmTUMPago": true,
  "analiseRetificacaoPendente": true,
  "blServico": false,
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "bloqueioImpedeEntregaCarga": true,
  "bloqueioImpedeVinculacaodespacho": true,
  "blsServico": [
    {
      "numero": "131905000000000"
    }
  ],
  "cargaBloqueada": false,
  "categoriaCarga": "string",
  "ceBlPrimTransporte": "BL-2019STS999",
  "cnpjAgenciaDesconsolidadora": "07395083000104",
  "cnpjAgenciaEmpresa": "07395083000104",
  "cnpjEmpresaDesconsolidadora": "07395083000104",
  "componenteFrete": [
    {
      "moeda": "220",
      "recolhimento": "PREPAID",
      "tipo": "01ª CAPATAZIA/THC/THD",
      "valor": "1000,00"
    }
  ],
  "cpfCnpjConsignatario": "07395083000104",
  "cpfCnpjParteNotificada": "07395083000104",
  "dadosComplementaresConsignatario": "SETOR NORTE – QDA 33",
  "dataDestinoFinal": "2019-07-15T00:00:00",
  "dataEmissao": "2019-07-15T00:00:00",
  "dataEmissaoPrimeiroTransporte": "2019-07-15T00:00:00",
  "dataSituacaoCarga": "2019-07-15T00:00:00",
  "descricaoMercadoria": "BOBINAS DE AÇO",
  "documentoDespacho": [
    {
      "documentoDespacho": "DI",
      "numero": "1900000001"
    }
  ],
  "endossoConhecimento": true,
  "eventoConhecimento": [
    {
      "dataEvento": "2019-07-15T00:00:00",
      "modalidade": "SUSPENSÃO",
      "motivo": "ENTREPOSTO ADUANEIRO DIRETO",
      "pesoLiquido": "10000.000",
      "valorAFRMM": "750.00",
      "valorContaEspec": "26750.00",
      "valorContaFundo": "85750.00",
      "valorFrete": "750.00",
      "valorVinculado": "56750.00"
    }
  ],
  "identificacaoEmbarcador": "00000000000353",
  "inconsistenciaCubagemMaster": true,
  "inconsistenciaFreteMaster": true,
  "inconsistenciaPesoMaster": true,
  "indicadorOficio": true,
  "indicadorPendenciaFrete": true,
  "manifestoDoCe": [
    {
      "numero": "1319500011627",
      "portoCarregamento": "USMIA",
      "portoDescarregamento": "BRRIO",
      "terminalCarregamento": "MIAMI",
      "terminalDescarregamento": "BRRIO001"
    }
  ],
  "modalidadeFrete": "string",
  "moedaFrete": "220",
  "motivoEndosso": "string",
  "motivoPendenciaTransitoMaritimo": "string",
  "navioPrimTransporte": "PPXI",
  "nomeConsignatarioEstrangeiro": "JOHN SILVA",
  "numero": "131905000000000",
  "numeroBlConhecimento": "BL13190500",
  "numeroCEMaster": "131908000000000",
  "observacoes": "FAVOR VERIFICAR O LACRE",
  "pagamentoFrete": "string",
  "paisDestinoFinal": "BR",
  "paisProcedencia": "US",
  "passaporteConsignatario": "BL89756",
  "pendenciaAFRMM": true,
  "pendenciaFrete": [
    {
      "dataRegistroPendenciaFrete": "2019-07-15T21:16:10",
      "pendenciaFrete": true,
      "responsavelPendenciaFrete": "07419402352"
    }
  ],
  "pesoBrutoKg": "30000.000",
  "portoAtracacaoAtual": "USMIA",
  "portoDestino": "BRRIO",
  "portoOrigem": "USMIA",
  "raArmazenamento": "7921301",
  "raArmazenamentoFinal": true,
  "revisaoAFRMM": true
}
Response Example (400 Bad Request) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (403 Forbidden) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (404 Not Found) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (422 Unprocessable Entity) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (500 Internal Server Error) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}

escalas

escalas

Consultar dados da escala.

GET /escalas/{nr}

Consultar dados da escala passada no PathVariable. Exemplo: URL_BASE_INTEGRA_COMEX/escalas/19000007952

Authorization: string
in header

Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. 'Bearer '

jwt_token: string
in header

Token JWT fornecido pelo serviço de autenticação (SAPI)

nr: string
in path

Número da Escala. O número não será validado e a api só retornará o encontrado.

200 OK
Escala

OK

400 Bad Request
Error

Requisição mal formada.

403 Forbidden
Error

Usuário não tem permissão para acessar o recurso solicitado

404 Not Found
Error

Recurso Não encontrado

422 Unprocessable Entity
Error

Erro de negócio

500 Internal Server Error
Error

Erro inesperado

Response Content-Types: application/json;charset=UTF-8
Response Example (200 OK) 
{
  "bandeiraEmbarcacao": "US",
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cnpjAgenciaNavegacao": "00000000000353",
  "cnpjEmpresaTransportador": "00000000000191",
  "cnpjResponsavelAtracacao": "42255331001365",
  "dataAtracacao": "2019-07-15T21:16:10",
  "dataInclusao": "2019-07-15T21:16:10",
  "dataPasseSaida": "2019-07-15T21:16:10",
  "dataPrevisaoAtracacao": "2019-07-15T21:16:10",
  "dataPrevisaoPasseSaida": "2019-07-15T21:16:10",
  "dataSituacao": "2019-07-15T21:16:10",
  "embarcacao": "7245376762",
  "empresaTransportador": "AR000438",
  "empresasParceiras": [
    {
      "cnpj": "00000000000272"
    }
  ],
  "escalaBloqueada": false,
  "indEscalaEncerrada": false,
  "localAtracacao": "BERÇO NUMERO 30",
  "manifestosParaEscala": [
    {
      "numero": "1319500011520"
    }
  ],
  "nacionalidadeTransportador": "BR",
  "numero": "19000004350",
  "numeroViagem": "12345",
  "operacoesRegistradas": [
    {
      "cnpjOperador": "00000000000353",
      "concluida": "boolean",
      "cpfFimOperacao": "12345678912",
      "cpfOperacao": "07395083001",
      "dataFimOperacao": "2019-07-15T21:16:10",
      "dataInicioOperacao": "2019-07-15T21:16:10",
      "local": "BERÇO NÚMERO 20",
      "situacaoEmbarcacao": "FUNDEADA",
      "terminalPortuario": "BRRIO001"
    }
  ],
  "operadoresIndicados": [
    {
      "cnpj": "00000000000272"
    }
  ],
  "porto": "BRRIO",
  "portosProcedencia": [
    {
      "codigo": "BRRIO",
      "dataPasseSaida": "2019-07-15T21:16:10"
    }
  ],
  "portosSubsequentes": [
    {
      "codigo": "BRRIO",
      "dataPrevisaoAtracacao": "2019-07-15T21:16:10"
    }
  ],
  "responsavelEmbarcacao": "BRASIL TRANSPORTADO SA",
  "situacao": "EM OPERAÇÃO",
  "terminalAtracacao": "BRRIO001",
  "termoAssinado": "boolean",
  "tipoOperacao": "CARGA"
}
Response Example (400 Bad Request) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (403 Forbidden) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (404 Not Found) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (422 Unprocessable Entity) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (500 Internal Server Error) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}

manifestos

manifestos

Consultar dados do Manifesto.

GET /manifestos/{nr}

Consultar dados do Manifesto passado no PathVariable. Exemplo: URL_BASE_INTEGRA_COMEX/manifestos/1319500010019

Authorization: string
in header

Access token fornecido pelo serviço de autenticação, prescedido do tipo de token. 'Bearer '

jwt_token: string
in header

Token JWT fornecido pelo serviço de autenticação (SAPI)

nr: string
in path

Número do Manifesto. O número não será validado e a api só retornará o encontrado.

200 OK
Manifesto

OK

400 Bad Request
Error

Requisição mal formada.

403 Forbidden
Error

Usuário não tem permissão para acessar o recurso solicitado

404 Not Found
Error

Recurso Não encontrado

422 Unprocessable Entity
Error

Erro de negócio

500 Internal Server Error
Error

Erro inesperado

Response Content-Types: application/json;charset=UTF-8
Response Example (200 OK) 
{
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cesManifesto": [
    "string"
  ],
  "cnpjAgenciaNavegacao": "07395083000104",
  "cnpjEmpresaNavegacao": "07395083000104",
  "codigoEmbarcacao": "PPXI",
  "conhecimentosIncluidos": "7",
  "conhecimentosInformados": "10",
  "conteinerVazio": [
    "string"
  ],
  "dataEmissao": "2019-07-15T21:16:10",
  "dataEncerramento": "2019-07-15T21:16:10",
  "dataOperacao": "2019-07-15T21:16:10",
  "embarcacaoComboio": [
    "string"
  ],
  "escalasDoManifesto": [
    {
      "dataVinculacao": "2019-07-15T21:16:10",
      "escala": "19500000000"
    }
  ],
  "manifestoBloqueado": false,
  "numero": "1319500012345",
  "numeroViagem": "01294",
  "portoCarregamento": "USMIA",
  "portoDescarregamento": "BRRIO",
  "terminalCarregamento": [
    "string"
  ],
  "terminalDescarregamento": [
    "string"
  ],
  "tipoTrafego": "string"
}
Response Example (400 Bad Request) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (403 Forbidden) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (404 Not Found) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (422 Unprocessable Entity) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}
Response Example (500 Internal Server Error) 
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}

Schema Definitions

Bloqueio: object

Representação de um bloqueio

codigoTipo: string

Código do tipo do Bloqueio
Tamanho: 2

data: string (date-time)

Data/hora do Bloqueio
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

descricaoTipo: string

Tipo do Bloqueio
Tamanho mínimo: 1
Tamanho máximo: 35

justificativa: string

Justificativa do Bloqueio
Tamanho mínimo: 1
Tamanho máximo: 500

motivo: string

Motivo do Bloqueio
Tamanho mínimo: 1
Tamanho máximo: 90

Example
{
  "codigoTipo": "02",
  "data": "2019-07-15T21:16:10",
  "descricaoTipo": "BLOQUEIO TOTAL",
  "justificativa": "BLOQUEIO AUTOMÁTICO",
  "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
}

Carga Solta: object

Representação de um item do tipo Carga Solta

bloqueio: Bloqueio

Bloqueios

Bloqueio
cargaBloqueada: boolean

Indicador de carga bloqueada
Dominio:
true
false

classeMercadoriaPerigosa: string

Classe de mercadoria perigosa
Tamanho mínimo: 1
Tamanho máximo: 4

codigoMercadoriaPerigosa: string

Código de mercadoria perigosa
Tamanho mínimo: 1
Tamanho máximo: 6

contraMarca: string

Contramarca
Tamanho: 55

cubagem: string

Cubagem
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 10.3

embalagens: Tipo de Embalagem de Madeira

Embalagens de Madeira

Tipo de Embalagem de Madeira
inEmbalagemMadeira: boolean

Indicador de utilização de embalagem de madeira
Dominio:
true
false

marca: string

Marca
Tamanho: 55

ncm: NCM

NCM

NCM
numero: string

Número do Item
Formato: 'NNNN'
Tamanho mínimo: 1
Tamanho máximo: 4

operacaoCodigoRA: string

Código RA da operação
Tamanho mínimo: 1
Tamanho máximo: 7

operacaoData: string (date-time)

Data da operação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

operacaoDescricao: string

Descrição da operação
Tamanho mínimo: 1
Tamanho máximo: 35

pesoBruto: string

Peso Bruto
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 9.3

quantidade: string

Quantidade
Formato: Inteiro, com até 7 digitos

tipoEmbalagem: string

Tipo de embalagem
Tamanho: 2

Example
{
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cargaBloqueada": false,
  "classeMercadoriaPerigosa": "101-23",
  "codigoMercadoriaPerigosa": "102-23",
  "contraMarca": "IHC DO BRASIL",
  "cubagem": "10.00",
  "embalagens": [
    {
      "codigoTipo": "001",
      "descricaoTipo": "Descricao do tipo 001"
    }
  ],
  "inEmbalagemMadeira": false,
  "marca": "IHC DO BRASIL",
  "ncm": [
    {
      "codigo": "84836011"
    }
  ],
  "numero": "1234",
  "operacaoCodigoRA": "string",
  "operacaoData": "string (date-time)",
  "operacaoDescricao": "string",
  "pesoBruto": "10000.000",
  "quantidade": "50",
  "tipoEmbalagem": "PALLET"
}

Conhecimento embarque: object

Representação do retorno do conhecimento de embarque

afrmmTUMPago: boolean

AFRMM e TUM pago
Dominio:
true
false

analiseRetificacaoPendente: boolean

Retificação pendente de análise
Dominio:
true
false

blServico: boolean

O BL é de serviço
Dominio:
true
false

bloqueio: Bloqueio

Bloqueios

Bloqueio
bloqueioImpedeEntregaCarga: boolean

Bloqueio impede entrega da carga
Dominio:
true
false

bloqueioImpedeVinculacaodespacho: boolean

Bloqueio impede vinculação de despacho
Dominio:
true
false

blsServico: Lista de Bl de Serviço

BLs de serviço

Lista de Bl de Serviço
cargaBloqueada: boolean

Carga bloqueada
Dominio:
true
false

categoriaCarga: string EXPORTADA, IMPORTADA, NACIONAL, ESTRANGEIRA_DE_PASSAGEM

Categoria da Carga
Tamanho mínimo: 8
Tamanho máximo: 23

ceBlPrimTransporte: string

Conhecimento de Embarque BL 1° transporte
Formato: 'AAAAAAAAAAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 18

cnpjAgenciaDesconsolidadora: string

CNPJ Agência Desconsolidadora
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

cnpjAgenciaEmpresa: string

CNPJ Agência ou Empresa Navegação
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

cnpjEmpresaDesconsolidadora: string

CNPJ Empresa Desconsolidadora
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

componenteFrete: Lista de componentes de frete

Componentes de frete

Lista de componentes de frete
cpfCnpjConsignatario: string

CPF/CNPJ Consignatário
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

cpfCnpjParteNotificada: string

CNPJ/CPF parte notificada
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

dadosComplementaresConsignatario: string

Dados Complementares Consignatário
Tamanho mínimo: 1
Tamanho máximo: 55

dataDestinoFinal: string (date-time)

Data de chegada no destino final
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataEmissao: string (date-time)

Data de emissão da Carga
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataEmissaoPrimeiroTransporte: string (date-time)

Data de Emissão 1° transporte
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataSituacaoCarga: string (date-time)

Data da Situação da Carga
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

descricaoMercadoria: string

Descrição da Mercadoria
Valor mínimo: 1
Valor máximo: 253

documentoDespacho: Lista de Documento de Despacho

Documento de despacho

Lista de Documento de Despacho
endossoConhecimento: boolean

Endosso do Conhecimento
Dominio:
true
false

eventoConhecimento: Lista de eventos do conhecimento

Eventos do Conhecimento

Lista de eventos do conhecimento
identificacaoEmbarcador: string

Identificação do Embarcador
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

inconsistenciaCubagemMaster: boolean

Inconsistencia de cubagem Master
Dominio:
true
false

inconsistenciaFreteMaster: boolean

Inconsistencia de frete Master
Dominio:
true
false

inconsistenciaPesoMaster: boolean

Inconsistencia de peso no CE Master
Dominio:
true
false

indicadorOficio: boolean

Indicador de ofício
Dominio:
true
false

indicadorPendenciaFrete: boolean

Pendência de frete
Dominio:
true
false

manifestoDoCe: Lista de manifestos do Conhecimento de embarque

Manifestos do Ce

Lista de manifestos do Conhecimento de embarque
modalidadeFrete: string HH, PP, HP, PH, NA

Modalidade do frete

moedaFrete: string

Moeda
Domínio: Tabela de Moedas do Siscomex.
Formato: 'NNN'
Tamanho: 3

motivoEndosso: string

Motivo do Endosso
Tamanho mínimo: 1
Tamanho máximo: 10

motivoPendenciaTransitoMaritimo: string

Descrição da Pendência de Trânsito Marítimo
Tamanho mínimo: 1
Tamanho máximo: 10

navioPrimTransporte: string

Navio 1° transporte
Tamanho mínimo: 1
Tamanho máximo: 55

nomeConsignatarioEstrangeiro: string

Nome do Consignatário Estrangeiro
Tamanho mínimo: 1
Tamanho máximo: 55

numero: string

Número do Ce Mercante
Formato: NNNNNNNNNNNNNNN
Tamanho: 15

numeroBlConhecimento: string

Conhecimento de Embarque
Formato: 'AAAAAAAAAAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 18

numeroCEMaster: string

Número do Ce Master
Formato: NNNNNNNNNNNNNNN
Tamanho: 15

observacoes: string

Observações
Valor mínimo: 1
Valor máximo: 253

pagamentoFrete: string PREPAID, COLLECT

Pagamento do Frete

paisDestinoFinal: string

País de destino final da carga
Formato: 'AA'
Tamanho: 2

paisProcedencia: string

País de procedência da carga
Formato: 'AA'
Tamanho: 2

passaporteConsignatario: string

Passaporte do Consignatário
Tamanho mínimo: 1
Tamanho máximo: 30

pendenciaAFRMM: boolean

Pendência de AFRMM por retificação de DI
Dominio:
true
false

pendenciaFrete: Lista de histórico da pendência de frete

Pendencia de frete

Lista de histórico da pendência de frete
pesoBrutoKg: string

Peso bruto
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 9.3

portoAtracacaoAtual: string

Porto de atracacao atual
Formato: AAAAA
Tamanho: 5

portoDestino: string

Porto de destino
Formato: AAAAA
Tamanho: 5

portoOrigem: string

Porto de origem
Formato: AAAAA
Tamanho: 5

raArmazenamento: string

Recinto de Armazenamento da Carga
Formato: 'NNNNNNN'
Tamanho: 7

raArmazenamentoFinal: boolean

Recinto de armazenamento final
Dominio:
true
false

revisaoAFRMM: boolean

Revisão de AFRMM por retificação de DI
Dominio:
true
false

situacaoAnaliseRetificacao: string EM_ANALISE, APROVADO, REJEITADO, SEM_RETIFICACAO

Situação do pedido análise de retificação

situacaoCarga: string MANIFESTADA, ENTREGA_AUTORIZADA, DESCARREGADA, CARREGADA, ARMAZENADA, VINCULADA_A_DOCUMENTO_DE_DESPACHO, ENTREGUE, EXCLUIDA, PARCIALMENTE_DESCARREGADA, PARCIALMENTE_CARREGADA, PARCIALMENTE_ARMAZENADA, CONTEINER_SHIPS_CONVENIENCE_DESCARREGADO, CONTEINER_SHIPS_CONVENIENCE_CARREGADO


Situação:
-Manifestada – Já declarada pelo transportador no sistema Mercante
-Carregada/Descarregada – Quando o Operador Portuário informa o boletim de Carga/Descarga
-Armazenada – Aquela cujo depositário já informou no Sistema Mantra a presença da carga (NIC). Ou no sistema PUCOMEX-CCT a recepção da carga pelo depositário, no caso de cargas vinculadas a DUIMP
-Vinculada a documento de despacho – Se existe DTA, DI, DI-OEA, DSI, DUIMP, DTSC registrada
-Carga entregue – Entrega foi efetuada no Siscomex Carga ou no sistema CCT do PUCOMEX

tipo: string BL, MBL, HBL, MHBL

Tipo do conhecimento

tipoConsignatario: string NACIONAL, EXTRANGEIRO, BL_A_ORDEM, PRACA_DE_ENTRGA_NO_EXTERIOR

Tipo Consignatário

totalDevido: string

Total devido
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

transbordoBaldeacao: Lista de Transbordo Baldeação

Transbordo/Baldeação

Lista de Transbordo Baldeação
transitoMaritimoPendente: boolean

Pendência de Trânsito Marítimo
Dominio:
true
false

ufDestino: string

UF de destino da carga
Dominio:
AC, AL, AP, AM, BA, CE, DF
ES, GO, MA, MT, MS, MG, PA
PB, PR, PE, PI, RJ, RN, RS
RO, RR, SC, SP, SE, TO

ulDestinoFinal: string

UL de destino final
Formato: 'NNNNNNN'
Tamanho: 7

valorAFRMM: string

Valor do AFRMM
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

valorCubagemM3: string

Cubagem
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 10.3

valorFreteBasico: string

Valor do Frete Básico
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 11.2

valorFreteTotal: string

Valor do Frete Total
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

valorJuros: string

Valor juros
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 13.2

valorMulta: string

Valor multa
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 13.2

valorTumDevida: string

Valor TUM devida
Formato: Decimal, com até 2 casas decimais separadas por ponto.

Example
{
  "afrmmTUMPago": true,
  "analiseRetificacaoPendente": true,
  "blServico": false,
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "bloqueioImpedeEntregaCarga": true,
  "bloqueioImpedeVinculacaodespacho": true,
  "blsServico": [
    {
      "numero": "131905000000000"
    }
  ],
  "cargaBloqueada": false,
  "categoriaCarga": "string",
  "ceBlPrimTransporte": "BL-2019STS999",
  "cnpjAgenciaDesconsolidadora": "07395083000104",
  "cnpjAgenciaEmpresa": "07395083000104",
  "cnpjEmpresaDesconsolidadora": "07395083000104",
  "componenteFrete": [
    {
      "moeda": "220",
      "recolhimento": "PREPAID",
      "tipo": "01ª CAPATAZIA/THC/THD",
      "valor": "1000,00"
    }
  ],
  "cpfCnpjConsignatario": "07395083000104",
  "cpfCnpjParteNotificada": "07395083000104",
  "dadosComplementaresConsignatario": "SETOR NORTE – QDA 33",
  "dataDestinoFinal": "2019-07-15T00:00:00",
  "dataEmissao": "2019-07-15T00:00:00",
  "dataEmissaoPrimeiroTransporte": "2019-07-15T00:00:00",
  "dataSituacaoCarga": "2019-07-15T00:00:00",
  "descricaoMercadoria": "BOBINAS DE AÇO",
  "documentoDespacho": [
    {
      "documentoDespacho": "DI",
      "numero": "1900000001"
    }
  ],
  "endossoConhecimento": true,
  "eventoConhecimento": [
    {
      "dataEvento": "2019-07-15T00:00:00",
      "modalidade": "SUSPENSÃO",
      "motivo": "ENTREPOSTO ADUANEIRO DIRETO",
      "pesoLiquido": "10000.000",
      "valorAFRMM": "750.00",
      "valorContaEspec": "26750.00",
      "valorContaFundo": "85750.00",
      "valorFrete": "750.00",
      "valorVinculado": "56750.00"
    }
  ],
  "identificacaoEmbarcador": "00000000000353",
  "inconsistenciaCubagemMaster": true,
  "inconsistenciaFreteMaster": true,
  "inconsistenciaPesoMaster": true,
  "indicadorOficio": true,
  "indicadorPendenciaFrete": true,
  "manifestoDoCe": [
    {
      "numero": "1319500011627",
      "portoCarregamento": "USMIA",
      "portoDescarregamento": "BRRIO",
      "terminalCarregamento": "MIAMI",
      "terminalDescarregamento": "BRRIO001"
    }
  ],
  "modalidadeFrete": "string",
  "moedaFrete": "220",
  "motivoEndosso": "string",
  "motivoPendenciaTransitoMaritimo": "string",
  "navioPrimTransporte": "PPXI",
  "nomeConsignatarioEstrangeiro": "JOHN SILVA",
  "numero": "131905000000000",
  "numeroBlConhecimento": "BL13190500",
  "numeroCEMaster": "131908000000000",
  "observacoes": "FAVOR VERIFICAR O LACRE",
  "pagamentoFrete": "string",
  "paisDestinoFinal": "BR",
  "paisProcedencia": "US",
  "passaporteConsignatario": "BL89756",
  "pendenciaAFRMM": true,
  "pendenciaFrete": [
    {
      "dataRegistroPendenciaFrete": "2019-07-15T21:16:10",
      "pendenciaFrete": true,
      "responsavelPendenciaFrete": "07419402352"
    }
  ],
  "pesoBrutoKg": "30000.000",
  "portoAtracacaoAtual": "USMIA",
  "portoDestino": "BRRIO",
  "portoOrigem": "USMIA",
  "raArmazenamento": "7921301",
  "raArmazenamentoFinal": true,
  "revisaoAFRMM": true,
  "situacaoAnaliseRetificacao": "string"
}

Contêiner: object

Representação de um item do tipo Contêiner

bloqueio: Bloqueio

Bloqueios

Bloqueio
cargaBloqueada: boolean

Indicador de carga bloqueada
Dominio:
true
false

classeMercadoriaPerigosa: string

Classe mercadoria perigosa
Tamanho mínimo: 1
Tamanho máximo: 4

codigoMercadoriaPerigosa: string

Código da mercadoria perigosa
Tamanho mínimo: 1
Tamanho máximo: 6

cubagem: string

Cubagem
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 10.3

embalagens: Tipo de Embalagem de Madeira

Embalagens de Madeira

Tipo de Embalagem de Madeira
identificacao: string

Identificação
Tamanho mínimo: 1
Tamanho máximo: 11

inEmbalagemMadeira: boolean

Indicador de utilização de embalagem de madeira
Dominio:
true
false

lacre: string[]

Lacres

string
ncm: NCM

NCM

NCM
numero: string

Número do Item
Formato: 'NNNN'
Tamanho mínimo: 1
Tamanho máximo: 4

operacaoCodigoRA: string

Código RA da operação
Tamanho mínimo: 1
Tamanho máximo: 7

operacaoData: string (date-time)

Data da operação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

operacaoDescricao: string

Descrição da operação
Tamanho mínimo: 1
Tamanho máximo: 35

pesoBruto: string

Peso Bruto
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 9.3

tara: string

Tara
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 6.3

tipo: string

Tipo do item Conteiner
Tamanho: 4

tipoConteiner: string

Tipo do conteiner
Tamanho: 4

usoParcial: boolean

Uso parcial
Dominio:
true
false

Example
{
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cargaBloqueada": false,
  "classeMercadoriaPerigosa": "4.1",
  "codigoMercadoriaPerigosa": "1325",
  "cubagem": "54.000",
  "embalagens": [
    {
      "codigoTipo": "001",
      "descricaoTipo": "Descricao do tipo 001"
    }
  ],
  "identificacao": "CAIU4974474",
  "inEmbalagemMadeira": false,
  "lacre": [
    "string"
  ],
  "ncm": [
    {
      "codigo": "84836011"
    }
  ],
  "numero": "1234",
  "operacaoCodigoRA": "string",
  "operacaoData": "string (date-time)",
  "operacaoDescricao": "string",
  "pesoBruto": "3700.000",
  "tara": "3700.000",
  "tipo": "45G0",
  "tipoConteiner": "45G0",
  "usoParcial": false
}

Error: object

Representação de Erros

details: string[]

Lista com mensagens detalhadas do erro (quando disponível)

string
error: string

Código de erro

message: string

Mensagem de erro

path: string

caminho do recurso com erro

timestamp: string

Data e hora em que ocorreu o problema ( no formato ISO 8601)

trackerId: string

Identificação única da requsição utilizada para rastrear a falha

Example
{
  "details": [
    "string"
  ],
  "error": "CA0999",
  "message": "mensagen de erro para o código CA0999",
  "path": "https://servidor/siscarga-consulta/api/conhecimentos-embarque/XXXXXXXXXXXXXXX",
  "timestamp": "2019-07-23T08:30:58.189",
  "trackerId": "TRK-A34ZM2"
}

Escala: object

Representação do retorno da Escala

bandeiraEmbarcacao: string

Bandeira da embarcação
Formato: 'AA'
Tamanho: 2

bloqueio: Bloqueio

Bloqueios

Bloqueio
cnpjAgenciaNavegacao: string

Agência de Navegação
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

cnpjEmpresaTransportador: string

CPNJ da Empresa do transportador
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

cnpjResponsavelAtracacao: string

Responsável pela atracação
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

dataAtracacao: string (date-time)

Data/Hora atracação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataInclusao: string (date-time)

Data da Inclusão da Escala
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataPasseSaida: string (date-time)

Data/Hora do passe de saída
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataPrevisaoAtracacao: string (date-time)

Data/Hora prevista da atracação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataPrevisaoPasseSaida: string (date-time)

Data/Hora prevista do Passe de saída
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataSituacao: string (date-time)

Data/Hora da situacao da escala
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

embarcacao: string

Embarcação
Formato: 'AAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 10

empresaTransportador: string

códido empresa do Transportador
Tamanho mínimo: 1
Tamanho máximo: 14

empresasParceiras: Lista de Empresas Parceiras

Empresas Parceiras

Lista de Empresas Parceiras
escalaBloqueada: boolean

Escala bloqueada
Dominio:
true
false

indEscalaEncerrada: boolean

Escala encerrada
Dominio:
true
false

localAtracacao: string

Local da Atracação
Tamanho mínimo: 1
Tamanho máximo: 250

manifestosParaEscala: Lista de manifestos

Lista de manifestos vinculados a escala

Lista de manifestos
nacionalidadeTransportador: string

Nacionalidade do Transportador
Tamanho: 2

numero: string

Número da Escala
Formato: 'NNNNNNNNNNN'
Tamanho: 11

numeroViagem: string

Número da Viagem do Armador
Formato: 'AAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 10

operacoesRegistradas: Lista de Operações Registradas

Lista de Operações Registradas

Lista de Operações Registradas
operadoresIndicados: Lista de Operadores Portuários

Lista de Operadores Portuarios indicados na Escala

Lista de Operadores Portuários
porto: string

Porto da Escala
Formato: AAAAA
Tamanho: 5

portosProcedencia: Lista de portos de procedência

Portos de procedência

Lista de portos de procedência
portosSubsequentes: Lista de portos subsequentes

Portos subsequentes

Lista de portos subsequentes
responsavelEmbarcacao: string

Responsável pela embarcação
Tamanho mínimo: 1
Tamanho máximo: 55

situacao: string

Situação da escala
Tamanho mínimo: 1
Tamanho máximo: 50

terminalAtracacao: string

Terminal de Atracação
Tamanho: 8

termoAssinado: boolean

Têrmo de Responsabilidade Assinado
Dominio:
true
false

tipoOperacao: string

Tipo da Operação Prevista
Dominio:
CARGA, DESCARGA, CARGA/DESCARGA, ABASTECIMENTO, PASSAGEIROS,
FORNECIMENTO DE BORDO, ARRIBADA, MILITAR COM CARGA, OUTROS

Example
{
  "bandeiraEmbarcacao": "US",
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cnpjAgenciaNavegacao": "00000000000353",
  "cnpjEmpresaTransportador": "00000000000191",
  "cnpjResponsavelAtracacao": "42255331001365",
  "dataAtracacao": "2019-07-15T21:16:10",
  "dataInclusao": "2019-07-15T21:16:10",
  "dataPasseSaida": "2019-07-15T21:16:10",
  "dataPrevisaoAtracacao": "2019-07-15T21:16:10",
  "dataPrevisaoPasseSaida": "2019-07-15T21:16:10",
  "dataSituacao": "2019-07-15T21:16:10",
  "embarcacao": "7245376762",
  "empresaTransportador": "AR000438",
  "empresasParceiras": [
    {
      "cnpj": "00000000000272"
    }
  ],
  "escalaBloqueada": false,
  "indEscalaEncerrada": false,
  "localAtracacao": "BERÇO NUMERO 30",
  "manifestosParaEscala": [
    {
      "numero": "1319500011520"
    }
  ],
  "nacionalidadeTransportador": "BR",
  "numero": "19000004350",
  "numeroViagem": "12345",
  "operacoesRegistradas": [
    {
      "cnpjOperador": "00000000000353",
      "concluida": "boolean",
      "cpfFimOperacao": "12345678912",
      "cpfOperacao": "07395083001",
      "dataFimOperacao": "2019-07-15T21:16:10",
      "dataInicioOperacao": "2019-07-15T21:16:10",
      "local": "BERÇO NÚMERO 20",
      "situacaoEmbarcacao": "FUNDEADA",
      "terminalPortuario": "BRRIO001"
    }
  ],
  "operadoresIndicados": [
    {
      "cnpj": "00000000000272"
    }
  ],
  "porto": "BRRIO",
  "portosProcedencia": [
    {
      "codigo": "BRRIO",
      "dataPasseSaida": "2019-07-15T21:16:10"
    }
  ],
  "portosSubsequentes": [
    {
      "codigo": "BRRIO",
      "dataPrevisaoAtracacao": "2019-07-15T21:16:10"
    }
  ],
  "responsavelEmbarcacao": "BRASIL TRANSPORTADO SA",
  "situacao": "EM OPERAÇÃO",
  "terminalAtracacao": "BRRIO001",
  "termoAssinado": "boolean",
  "tipoOperacao": "CARGA"
}

Granél: object

Representação de um item do tipo granél

bloqueio: Bloqueio

Bloqueios

Bloqueio
cargaBloqueada: boolean

Indicador de carga bloqueada
Dominio:
true
false

classeMercadoriaPerigosa: string

Classe de mercadoria perigosa
Tamanho mínimo: 1
Tamanho máximo: 4

codigoMercadoriaPerigosa: string

Código de mercadoria perigosa
Tamanho mínimo: 1
Tamanho máximo: 6

cubagem: string

Cubagem
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 10.3

embalagens: Tipo de Embalagem de Madeira

Embalagens de Madeira

Tipo de Embalagem de Madeira
inEmbalagemMadeira: boolean

Indicador de utilização de embalagem de madeira
Dominio:
true
false

ncm: NCM

NCM

NCM
numero: string

Número do Item
Formato: 'NNNN'
Tamanho mínimo: 1
Tamanho máximo: 4

pesoBruto: string

Peso Bruto
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 9.3

tipo: string

Tipo de granel
Tamanho mínimo: 1
Tamanho máximo: 50

Example
{
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cargaBloqueada": false,
  "classeMercadoriaPerigosa": "1012",
  "codigoMercadoriaPerigosa": "102-23",
  "cubagem": "1000.000",
  "embalagens": [
    {
      "codigoTipo": "001",
      "descricaoTipo": "Descricao do tipo 001"
    }
  ],
  "inEmbalagemMadeira": false,
  "ncm": [
    {
      "codigo": "84836011"
    }
  ],
  "numero": "1234",
  "pesoBruto": "1000000.000",
  "tipo": "SOJA EM GRÃO"
}

Item: object

Representação do retorno de um item do conhecimento de embarque

cargasSoltas: Carga Solta

Cargas soltas

Carga Solta
conteineres: Contêiner

Contêineres

Contêiner
graneis: Granél

Granéis

Granél
numero: string

Número do CE Mercante
Formato: NNNNNNNNNNNNNNN
Tamanho: 15

qtdItensRecebidos: integer (int32)

Quantidade de itens retornados na requisição.
Formato: Inteiro, com até 4 digitos

qtdItensRestantes: integer (int32)

Quantidade de itens restantes nas páginas seguintes.
Formato: Inteiro, com até 4 digitos

qtdTotalItens: integer (int32)

Quantidade total de itens do CE.
Formato: Inteiro, com até 4 digitos

veiculos: Veículo

Veículos

Veículo
Example
{
  "cargasSoltas": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "101-23",
      "codigoMercadoriaPerigosa": "102-23",
      "contraMarca": "IHC DO BRASIL",
      "cubagem": "10.00",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "inEmbalagemMadeira": false,
      "marca": "IHC DO BRASIL",
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "operacaoCodigoRA": "string",
      "operacaoData": "string (date-time)",
      "operacaoDescricao": "string",
      "pesoBruto": "10000.000",
      "quantidade": "50",
      "tipoEmbalagem": "PALLET"
    }
  ],
  "conteineres": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "4.1",
      "codigoMercadoriaPerigosa": "1325",
      "cubagem": "54.000",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "identificacao": "CAIU4974474",
      "inEmbalagemMadeira": false,
      "lacre": [
        "string"
      ],
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "operacaoCodigoRA": "string",
      "operacaoData": "string (date-time)",
      "operacaoDescricao": "string",
      "pesoBruto": "3700.000",
      "tara": "3700.000",
      "tipo": "45G0",
      "tipoConteiner": "45G0",
      "usoParcial": false
    }
  ],
  "graneis": [
    {
      "bloqueio": [
        {
          "codigoTipo": "02",
          "data": "2019-07-15T21:16:10",
          "descricaoTipo": "BLOQUEIO TOTAL",
          "justificativa": "BLOQUEIO AUTOMÁTICO",
          "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
        }
      ],
      "cargaBloqueada": false,
      "classeMercadoriaPerigosa": "1012",
      "codigoMercadoriaPerigosa": "102-23",
      "cubagem": "1000.000",
      "embalagens": [
        {
          "codigoTipo": "001",
          "descricaoTipo": "Descricao do tipo 001"
        }
      ],
      "inEmbalagemMadeira": false,
      "ncm": [
        {
          "codigo": "84836011"
        }
      ],
      "numero": "1234",
      "pesoBruto": "1000000.000",
      "tipo": "SOJA EM GRÃO"
    }
  ]
}

Lista de Bl de Serviço: object

Representação da lista de Bl de Serviço

numero: string

Número do Bl de Seviço
Formato: NNNNNNNNNNNNNNN
Tamanho: 15

Example
{
  "numero": "131905000000000"
}

Lista de Documento de Despacho: object

Representação da lista de Documento de Despacho

documentoDespacho: string DI, DSI, DTA, DE, DUIMP, DUE

Tipo de Documento

numero: string

Numero do Documento
Tamanho mínimo: 1
Tamanho máximo: 15

Example
{
  "documentoDespacho": "DI",
  "numero": "1900000001"
}

Lista de Empresas Parceiras: object

Representação da lista de Empresas Parceiras

cnpj: string

CNPJ
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

Example
{
  "cnpj": "00000000000272"
}

Lista de Escalas do Manifesto: object

Representação da lista de Escalas do Manifesto

dataVinculacao: string (date-time)

Data da vinculação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

escala: string

Escalas
Formato: 'NNNNNNNNNNN'
Tamanho: 11

Example
{
  "dataVinculacao": "2019-07-15T21:16:10",
  "escala": "19500000000"
}

Lista de Operadores Portuários: object

Representação da lista de Operadores Portuários indicados na escala

cnpj: string

CNPJ
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

Example
{
  "cnpj": "00000000000272"
}

Lista de Operações Registradas: object

Representação da lista de Operações registradas

cnpjOperador: string

CNPJ do Operador Portuário
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

concluida: boolean

Operação concluída
Dominio:
true
false

cpfFimOperacao: string

Responsável fim da operação
Formato: 'NNNNNNNNNNN'
Tamanho: 11

cpfOperacao: string

Responsável pela Operação
Formato: 'NNNNNNNNNNN'
Tamanho: 11

dataFimOperacao: string (date-time)

Data/hora do fim da operação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataInicioOperacao: string (date-time)

Data/hora do início da operação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

local: string

Local da Embarcação
Tamanho mínimo: 1
Tamanho máximo: 50

situacaoEmbarcacao: string FUNDEADA, ATRACADA

Situção da Embarcação
Dominio:
FUNDEADA
ATRACADA

terminalPortuario: string

Terminal portuário
Tamanho: 8

Example
{
  "cnpjOperador": "00000000000353",
  "concluida": "boolean",
  "cpfFimOperacao": "12345678912",
  "cpfOperacao": "07395083001",
  "dataFimOperacao": "2019-07-15T21:16:10",
  "dataInicioOperacao": "2019-07-15T21:16:10",
  "local": "BERÇO NÚMERO 20",
  "situacaoEmbarcacao": "FUNDEADA",
  "terminalPortuario": "BRRIO001"
}

Lista de Transbordo Baldeação: object

Representação da lista de Transbordo/Baldeação

navio: string

Navio
Formato: 'AAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 10

porto: string

Porto
Formato: AAAAA
Tamanho: 5

Example
{
  "navio": "PPXI",
  "porto": "BRRIO"
}

Lista de componentes de frete: object

Representação da lista de componentes de frete

moeda: string

Moeda
Domínio: Tabela de Moedas do Siscomex.
Formato: 'NNN'
Tamanho: 3

recolhimento: string PREPAID, COLLECT

Recolhimento

tipo: string PRIMEIRA_CAPATAZIA_THC_THD, SEGUNDA_CAF, TERCEIRA_BAF, QUARTA_TAXA_DO_C_E, QUINTA_TAXA_DO_C_E, SEXTA_TAXA_DO_C_E, SETIMA_TAXA_DO_C_E, OITAVA_TAXA_DO_C_E, NONA_TAXA_DO_C_E, DECIMA_TAXA_DO_C_E, DECIMA_PRIMEIRA_TAXA_DO_C_E, DECIMA_SEGUNDA_TAXA_DO_C_E, DECIMA_TERCEIRA_TAXA_DO_C_E, DECIMA_QUARTA_TAXA_DO_C_E, DECIMA_QUINTA_TAXA_DO_C_E

Tipo

valor: string

Valor
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

Example
{
  "moeda": "220",
  "recolhimento": "PREPAID",
  "tipo": "01ª CAPATAZIA/THC/THD",
  "valor": "1000,00"
}

Lista de eventos do conhecimento: object

Representação da lista de eventos do conhecimento

dataEvento: string (date-time)

Data/hora do evento
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

modalidade: string

Modalidade

motivo: string

Motivo
Tamanho mínimo: 1
Tamanho máximo: 55

pesoLiquido: string

Peso líquido
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 9.3

valorAFRMM: string

Valor do AFRMM
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

valorContaEspec: string

Valor conta espec
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

valorContaFundo: string

Valor conta fundo
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

valorFrete: string

Valor do Frete
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 11.2

valorVinculado: string

Valor vinculado
Formato: Decimal, com até 2 casas decimais separadas por ponto.
Tamanho: 15.2

Example
{
  "dataEvento": "2019-07-15T00:00:00",
  "modalidade": "SUSPENSÃO",
  "motivo": "ENTREPOSTO ADUANEIRO DIRETO",
  "pesoLiquido": "10000.000",
  "valorAFRMM": "750.00",
  "valorContaEspec": "26750.00",
  "valorContaFundo": "85750.00",
  "valorFrete": "750.00",
  "valorVinculado": "56750.00"
}

Lista de histórico da pendência de frete: object

Representação do histórico da Pendência de Frete

dataRegistroPendenciaFrete: string (date-time)

Data de registro da pendência de frete
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

pendenciaFrete: boolean

Situação da pendência de frete

responsavelPendenciaFrete: string

Responsável pelo registro
Formato: 'NNNNNNNNNNN'
Tamanho: 11

Example
{
  "dataRegistroPendenciaFrete": "2019-07-15T21:16:10",
  "pendenciaFrete": true,
  "responsavelPendenciaFrete": "07419402352"
}

Lista de manifestos: object

Representação de manifestos

numero: string

Número do manifesto
Formato: 'AAAAAAAAAAAAA'
Tamanho: 13

Example
{
  "numero": "1319500011520"
}

Lista de manifestos do Conhecimento de embarque: object

Representação de manifestos do ce

numero: string

Número do manifesto
Formato: 'AAAAAAAAAAAAA'
Tamanho: 13

portoCarregamento: string

Porto de Carregamento
Formato: AAAAA
Tamanho: 5

portoDescarregamento: string

Porto de Descarregamento
Formato: AAAAA
Tamanho: 5

terminalCarregamento: string

Terminal de Carregamento
Formato: AAAAAAAA
Tamanho: 8

terminalDescarregamento: string

Terminal deDescarregamento
Formato: AAAAAAAA
Tamanho: 8

Example
{
  "numero": "1319500011627",
  "portoCarregamento": "USMIA",
  "portoDescarregamento": "BRRIO",
  "terminalCarregamento": "MIAMI",
  "terminalDescarregamento": "BRRIO001"
}

Lista de portos de procedência: object

Representação de portos de procedência

codigo: string

Código
Tamanho: 5

dataPasseSaida: string (date-time)

Data do passe de saída
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

Example
{
  "codigo": "BRRIO",
  "dataPasseSaida": "2019-07-15T21:16:10"
}

Lista de portos subsequentes: object

Representação de portos subsequentes

codigo: string

Código
Tamanho: 5

dataPrevisaoAtracacao: string (date-time)

Data de Previsão de Atracação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

Example
{
  "codigo": "BRRIO",
  "dataPrevisaoAtracacao": "2019-07-15T21:16:10"
}

Manifesto: object

Representação do retorno do manifesto de carga

bloqueio: Bloqueio

Bloqueios

Bloqueio
cesManifesto: string[]

CEs do manifesto

string
cnpjAgenciaNavegacao: string

CNPJ da agência de navegação
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

cnpjEmpresaNavegacao: string

CNPJ da empresa de navegação
Formato: 'NNNNNNNNNNNNNN'
Tamanho: 14

codigoEmbarcacao: string

Código da embarcação
Formato: 'AAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 10

conhecimentosIncluidos: string

Conhecimentos incluídos
Formato: Inteiro, com até 4 digitos

conhecimentosInformados: string

Conhecimentos informados
Formato: Inteiro, com até 4 digitos

conteinerVazio: string[]

Contêiner vazio

string
dataEmissao: string (date-time)

Data de emissão do manifesto
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataEncerramento: string (date-time)

Data de encerramento do manifesto
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

dataOperacao: string (date-time)

Data de operação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

embarcacaoComboio: string[]

Código da embarcação de Comboio

string
escalasDoManifesto: Lista de Escalas do Manifesto

Informações da Escala

Lista de Escalas do Manifesto
manifestoBloqueado: boolean

Manifesto bloqueado
Dominio:
true
false

numero: string

Número do manifesto
Formato: 'AAAAAAAAAAAAA'
Tamanho: 13

numeroViagem: string

Número da viagem
Formato: 'AAAAAAAAAA'
Tamanho mínimo: 1
Tamanho máximo: 10

portoCarregamento: string

Porto de carregamento
Formato: AAAAA
Tamanho: 5

portoDescarregamento: string

Porto de descarregamento
Formato: AAAAA
Tamanho: 5

terminalCarregamento: string[]

Terminal portuário de carregamento

string
terminalDescarregamento: string[]

Terminal portuário de descarregamento

string
tipoTrafego: string APOIO_MARITIMO, APOIO_PORTUARIO, BALDEACAO_CARGA_ESTRANGEIRA, BALDEACAO_CARGA_NACIONAL, CABOTAGEM, INTERIOR, LONGO_CURSO, LONGO_CURSO_EXPORTACAO, LONGO_CURSO_IMPORTACAO, PASSAGEM

Tipo de tráfego

Example
{
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cesManifesto": [
    "string"
  ],
  "cnpjAgenciaNavegacao": "07395083000104",
  "cnpjEmpresaNavegacao": "07395083000104",
  "codigoEmbarcacao": "PPXI",
  "conhecimentosIncluidos": "7",
  "conhecimentosInformados": "10",
  "conteinerVazio": [
    "string"
  ],
  "dataEmissao": "2019-07-15T21:16:10",
  "dataEncerramento": "2019-07-15T21:16:10",
  "dataOperacao": "2019-07-15T21:16:10",
  "embarcacaoComboio": [
    "string"
  ],
  "escalasDoManifesto": [
    {
      "dataVinculacao": "2019-07-15T21:16:10",
      "escala": "19500000000"
    }
  ],
  "manifestoBloqueado": false,
  "numero": "1319500012345",
  "numeroViagem": "01294",
  "portoCarregamento": "USMIA",
  "portoDescarregamento": "BRRIO",
  "terminalCarregamento": [
    "string"
  ],
  "terminalDescarregamento": [
    "string"
  ],
  "tipoTrafego": "string"
}

NCM: object

Representação de uma NCM

codigo: string

Código da NCM
Tamanho: 8

Example
{
  "codigo": "84836011"
}

Tipo de Embalagem de Madeira: object

Representação do Tipo de Embalagem de Madeira

codigoTipo: string

Código do tipo de embalagem
Tamanho: 3

descricaoTipo: string

Descrição do tipo de embalagem
Tamanho mínimo: 1
Tamanho máximo: 50

Example
{
  "codigoTipo": "001",
  "descricaoTipo": "Descricao do tipo 001"
}

Veículo: object

Representação de um item do tipo veículo

bloqueio: Bloqueio

Bloqueios

Bloqueio
cargaBloqueada: boolean

Indicador de Carga bloqueada
Dominio:
true
false

chassi: string

Número do chassi
Tamanho mínimo: 1
Tamanho máximo: 30

contraMarca: string

Contramarca
Tamanho mínimo: 1
Tamanho máximo: 55

embalagens: Tipo de Embalagem de Madeira

Embalagens de Madeira

Tipo de Embalagem de Madeira
inEmbalagemMadeira: boolean

Indicador de utilização de embalagem de madeira
Dominio:
true
false

marca: string

Marca
Tamanho mínimo: 1
Tamanho máximo: 55

ncm: NCM

NCM

NCM
numero: string

Número do Item
Formato: 'NNNN'
Tamanho mínimo: 1
Tamanho máximo: 4

operacaoCodigoRA: string

Código RA da operação
Tamanho mínimo: 1
Tamanho máximo: 7

operacaoData: string (date-time)

Data da operação
Formato: 'yyyy-MM-dd'T'HH:mm:ss.SSSZ'

operacaoDescricao: string

Descrição da operação
Tamanho mínimo: 1
Tamanho máximo: 35

pesoBruto: string

Peso Bruto
Formato: Decimal, com até 3 casas decimais separadas por ponto.
Tamanho: 9.3

Example
{
  "bloqueio": [
    {
      "codigoTipo": "02",
      "data": "2019-07-15T21:16:10",
      "descricaoTipo": "BLOQUEIO TOTAL",
      "justificativa": "BLOQUEIO AUTOMÁTICO",
      "motivo": "ALTERAÇÃO DE CARGA APÓS O PRAZO"
    }
  ],
  "cargaBloqueada": false,
  "chassi": 952323232365,
  "contraMarca": "IDEA",
  "embalagens": [
    {
      "codigoTipo": "001",
      "descricaoTipo": "Descricao do tipo 001"
    }
  ],
  "inEmbalagemMadeira": false,
  "marca": "FIAT",
  "ncm": [
    {
      "codigo": "84836011"
    }
  ],
  "numero": "1234",
  "operacaoCodigoRA": "string",
  "operacaoData": "string (date-time)",
  "operacaoDescricao": "string",
  "pesoBruto": "2000.000"
}
Documentation by Spectacle