Funcionalidade
Descrição dos campos de chamada e retorno da API, e exemplos.
- Descrição dos campos de chamada
- Descrição dos campos de retorno
- Exemplos de chamada
- Exemplos de retorno
Descrição dos campos de chamada
| Campo | PAI | Descrição | Obrigatório |
| Offset | / |
Determina a página demonstrada no retorno Ex.: Se o retorno possui 20 páginas, e na chamada for preenchido "offset": "12", trará apenas o retorno dos itens presentes na página 12. Obs.: Caso marcado com 0 ou 1, traz retorno da primeira página |
Não |
| Itens | / | / | / |
| ID | itens | Sequencial | Não |
| NCM | itens | NCM do produto | Apenas se não for informado o ponteiro |
| 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. Se não, busca na tabela CEST um registro vigente na data indicada | Não |
| ponteiro | itens | Se for enviado ponteiro busca dados a partir do ponteiro+1 | 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 |
| TotalPaginas | / | Número total de páginas do retorno |
| TotalItens | / | Numéro total de itens no retorno |
| ultPonteiro | / |
Informa o último ponteiro de atualização da tabela. Ex.: Numa chamada com 100 itens pode vir ponteiros diferentes pra cada item, a tag informa o último ponteiro da tabela de atualizações atualmente |
| 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) |
| EX_TIPITabela | itens | Código EX da TIPI (tabela Systax) |
| UFTabela | itens | UF (tabela CEST Systax) |
| CEST | itens | Código CEST |
| descricao | itens | Descrição do CEST |
| vigenciaDe | itens | Data inicial da vigência |
| vigenciaAte | itens | Data final da vigência |
| status | / | / |
| codigo | status | Código do retorno |
| ponteiro | itens | ponteiro de atualização da busca |
| msg | status | Mensagem de retorno |
Tabela de referência para os campos "codigo" e "mensagem":
| Código | Mensagem |
| 0 | RETORNO COM SUCESSO |
| 1 | NCM INVÁLIDA |
| 2 | NCM NÃO POSSUI CEST |
| 3 | UF INVÁLIDA |
| 4 | EX TIPI INVÁLIDA |
| 5 | DATA INVÁLIDA |
| 6 | ID INVÁLIDO |
| 7 | PONTEIRO INVÁLIDO |
| 8 | NÃO EXISTEM ATUALIZAÇOES |
Códigos de retorno HTTP:
| Código de retorno | sucess | message |
| 200 | true | Retorno com sucesso |
| 400 | false | missing_token |
| 400 | false | expired_token |
| 406 | false | Parâmetros insuficientes |
Exemplos de chamada
{
"offset": "1",
"itens": [
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"ponteiro": ""
}
]
}
Exemplos de retorno
[
{
"TotalPaginas": 1,
"totalItens": 13,
"ultPonteiro": "20231114020001",
"itens": [
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "2208",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0299900",
"descricao": "Outras bebidas alcoólicas não especificadas nos itens anteriores",
"vigenciaDe": "2016-10-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0200100",
"descricao": "Aperitivos, amargos, bitter e similares",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0200200",
"descricao": "Batida e similares",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0200300",
"descricao": "Bebida ice",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0200500",
"descricao": "Catuaba e similares",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0200700",
"descricao": "Cooler",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0200900",
"descricao": "Jurubeba e similares",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0201400",
"descricao": "Steinhaeger",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0201500",
"descricao": "Tequila",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0201900",
"descricao": "Derivados de vodka",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0202000",
"descricao": "Arak",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "0202300",
"descricao": "Sangrias e coquetéis",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
},
{
"id": "1",
"NCM": "22089000",
"EX_TIPI": "",
"UF": "",
"data": "",
"NCMTabela": "22089000",
"EX_TIPITabela": "",
"UFTabela": "",
"CEST": "1101000",
"descricao": "Álcool etílico para limpeza",
"vigenciaDe": "2016-01-01",
"vigenciaAte": "",
"status": {
"codigo": 0,
"ponteiro": "20231013095117",
"msg": "RETORNO COM SUCESSO"
}
}
]
}
]