Funcionalidade

Descrição dos campos de chamada e retorno da API, e exemplos.

Descrição dos campos de chamada

Campo PAI Descrição Obrigatório
itens / / /
id itens Sequencial Não
NCM itens NCM do produto Sim
EX_TIPI itens Código EX da TIPI Não
UF itens UF de consulta. Se UF="vazio" busca na tabela um registro com UF_origem=”vazio” e UF_destino”=”vazio”. Senão, busca na tabela um registro com UF_origem <> “vazio” ou UF destino <> “vazio”  Não
data itens Data de consulta. Se data="vazio" considera a data atual. Senão, busca na tabela CEST um registro vigente na data indicada    Não

 

Observação Os dados são indicados em formato de lista com um limite de 100 itens por requisição.

Descrição dos campos de retorno

Campo PAI Descrição
itens / /
id itens Sequencial 
NCM itens NCM de consulta
EX_TIPI itens Código EX da TIPI de consulta
UF itens UF de consulta
data itens Data de consulta
NCMTabela itens Código NCM (tabela Systax) 
CEST itens Código CEST
Descrição itens Descrição do CEST
UFTabela itens UF (tabela CEST Systax)
ExTipiTabela itens Código EX da TIPI (tabela Systax) 
codigo status Código do retorno
msg status Mensagem do retorno

 

Tabela de referência para os campos "codigo" e "mensagem":

codigo mensagem
0 Sucesso
1 NCM_Inválida
2 NCM_Sem_CEST
3 UF_Inválida
4 EX_TIPI_Inválida
5 Data_Inválida
6 ID_Inválido

 

Códigos de retorno HTTP:

Código de retorno success message
200 true Retorno com sucesso
400 false missing_token
false expired_token
406 false Parâmetros insuficientes

 

Exemplos de chamada

{
  "itens": [
    {
      "id": "1",
      "NCM": "39181000",
      "EX_TIPI": "",
      "UF": "",
      "data": "01/10/2020"
    }
  ]
}

Exemplos de retorno

[
  {
    "itens": [
      {
        "id": "1",
        "NCM": "39181000",
        "EX_TIPI": "",
        "UF": "",
        "data": "01\/10\/2020",
        "NCMTabela": "39",
        "EX_TIPITabela": "",
        "UFTabela": "PR",
        "CEST": "1000600",
        "descricao": "Mangueira de plástico de jardim",
        "status": {
          "codigo": 0,
          "msg": "RETORNO COM SUCESSO"
        }
      },
      {
        "id": "1",
        "NCM": "39181000",
        "EX_TIPI": "",
        "UF": "",
        "data": "01\/10\/2020",
        "NCMTabela": "39",
        "EX_TIPITabela": "",
        "UFTabela": "GO",
        "CEST": "1000600",
        "descricao": "Mangueira de plástico de jardim",
        "status": {
          "codigo": 0,
          "msg": "RETORNO COM SUCESSO"
        }
      },
      {
        "id": "1",
        "NCM": "39181000",
        "EX_TIPI": "",
        "UF": "",
        "data": "01\/10\/2020",
        "NCMTabela": "3918",
        "EX_TIPITabela": "",
        "UFTabela": "",
        "CEST": "1000700",
        "descricao": "Revestimento de pavimento de PVC e outros plásticos",
        "status": {
          "codigo": 0,
          "msg": "RETORNO COM SUCESSO"
        }
      },
      {
        "id": "1",
        "NCM": "39181000",
        "EX_TIPI": "",
        "UF": "",
        "data": "01\/10\/2020",
        "NCMTabela": "39181000",
        "EX_TIPITabela": "",
        "UFTabela": "",
        "CEST": "0100300",
        "descricao": "Protetores de caçamba",
        "status": {
          "codigo": 0,
          "msg": "RETORNO COM SUCESSO"
        }
      }
    ]
  }
]