Consulta

O serviço de consulta lista os itens já classificados, ou seja, que contenham NCM definitiva.

Método: GET
URL: https://app.systax.com.br/v2/cfm/products

Descrição dos campos da Request e Response

Request

Os campos que podem ser enviados são:

Nome Tipo Descrição
tipo_retorno Texto Define quais informações devem ser retornadas. Opções possíveis: ncm, duvida ou infos (default).
  • ncm retorna: id, cod_interno, origem_produto, ncm_sugerida e ex_tipi_sugerida;
  • duvida retorna: id, cod_interno, origem_produto e duvida_tecnica;
  • infos retorna: retorna todos os dados do produto;
id Inteiro ID do produto. Se esse filtro for utilizado, todos os outros filtros serão ignorados, caso sejam utilizados ao mesmo tempo
list_ids Texto Lista de id's separados por vírgula. Se enviado, os parâmetros cod_interno e origem_produto serão ignorados. 
data_criacao Texto Permite filtrar o dia exato 15/08/2019 ou uma faixa 20/04/2019a27/12/2019
param Array[Texto] Array de parâmetros para filtrar os produtos. Deve ser combinado com o parâmetro value[]. Opções: cod_interno, origem_produto, ean, descricao, complemento, ncm_original, ex_tipi_original, ncm_sugerida, ex_tipi_sugerida, ncm_definitiva, ex_tipi_definitiva, status_atual.
value Array[Texto] Array de valores para filtrar os produtos. Deve ser combinado com o parâmetro param[] Para o filtro status_atual, utilizar os valores: novo, classificado, pendente ou aguardando-ncm-definitiva.
pagina_atual Inteiro Página que se deseja consultar.
por_pagina Inteiro Quantidade de registros por página.
order_by Inteiro Define a ordenação dos resultados. Opções: id, cod_interno, descricao e data_criacao. Acrescente .ASC ou .DESC se necessário. Exemplos cod_interno, id.DESC, descricao.ASC

Importante: Os parâmetros deverão ser enviados na query string da url.

 

Paginação

Se a quantidade de itens retornados for maior do que uma página, um bloco adicional "paginacao" será devolvido contendo algumas informações importantes para a leitura dos itens paginados.

 Esse bloco conterá as seguintes informações:

Nome Tipo Descrição
total_registros Texto A quantidade total de registros disponíveis para consulta. 
num_paginas Texto A quantidade total de páginas em que esses registros se distribuem.
por_pagina Inteiro A quantidade de itens por págian informada na requisição.
pagina_atual Inteiro A página que se está consultando no momento.
itens_da_pagina Inteiro A quantidade de itens retornados na página atual. Será menor do que o tamanho da página quando se estiver lendo a última

Exemplo - Consulta de todos os itens

Endpoint: https://app.systax.com.br/v2/cfm/products

Response

{
    "success": true,
    "message": "ok",
    "record_count": 15,
    "produtos": [
        {
            "id": 18893817,
            "cod_interno": "00004-900",
            "origem_produto": 1,
            "ean": "",
            "descricao": "Produto_Teste_001",
            "descricao_sugerida": "",
            "complemento": "Teste",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "25231000",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "25231000",
            "ex_tipi_definitiva": "",
            "cest": "1709100",
            "status_atual": "classificado",
            "username_classificacao": "paulo.campos",
            "duvida_tecnica": "",
            "resposta_tecnica": "Teste",
            "fundamentacao": "",
            "dt_classificacao": "2025-04-10 16:58:49",
            "data_criacao": "2025-04-03 15:01:41",
            "username_criacao": "Teste"
        },
        {
            "id": 18893820,
            "cod_interno": "00117000611",
            "origem_produto": 1,
            "ean": "",
            "descricao": "Produto_Teste_002",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "22021000",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "73181600",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": "Dúvida Teste 1? Dúvida Teste 2?",
            "resposta_tecnica": "Teste",
            "fundamentacao": "",
            "dt_classificacao": "2025-06-23 14:41:04",
            "data_criacao": "2025-04-03 15:03:04",
            "username_criacao": "Teste"
        },
        {
            "id": 18893831,
            "cod_interno": "00117000612",
            "origem_produto": 1,
            "ean": "",
            "descricao": "Produto_Teste_003",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "87089990",
            "ex_tipi_original": "",
            "ncm_sugerida": "87089910",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "",
            "ex_tipi_definitiva": "",
            "cest": "0107500",
            "status_atual": "novo",
            "username_classificacao": null,
            "duvida_tecnica": "Dúvida Teste 3? Dúvida Teste 4?",
            "resposta_tecnica": "",
            "fundamentacao": "",
            "dt_classificacao": null,
            "data_criacao": "2025-04-03 15:04:34",
            "username_criacao": "Teste"
        },
        {
            "id": 18928122,
            "cod_interno": "10042025",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_004",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "22021000",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": "Dúvida Teste 5? Dúvida Teste 6?",
            "resposta_tecnica": "Teste",
            "fundamentacao": "",
            "dt_classificacao": "2025-06-23 12:05:58",
            "data_criacao": "2025-04-10 15:58:48",
            "username_criacao": "Teste"
        },
        {
            "id": 18933331,
            "cod_interno": "000006",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_005",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "22021000",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": "Teste",
            "fundamentacao": null,
            "dt_classificacao": "2025-04-11 10:56:16",
            "data_criacao": "2025-04-11 10:21:48",
            "username_criacao": "Teste"
        },
        {
            "id": 19145713,
            "cod_interno": "000009",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_006",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "22021000",
            "ex_tipi_definitiva": "",
            "cest": "1711100",
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": "Teste",
            "fundamentacao": null,
            "dt_classificacao": "2025-08-26 14:15:39",
            "data_criacao": "2025-05-26 14:36:46",
            "username_criacao": "Teste"
        },
        {
            "id": 19145715,
            "cod_interno": "000011",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_007",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "22021000",
            "ex_tipi_definitiva": "",
            "cest": "1711100",
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": "Teste",
            "fundamentacao": null,
            "dt_classificacao": "2025-08-26 14:16:08",
            "data_criacao": "2025-05-26 14:37:04",
            "username_criacao": "Teste"
        },
        {
            "id": 19265044,
            "cod_interno": "00012",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_008",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "22021000",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": "Teste",
            "fundamentacao": null,
            "dt_classificacao": "2025-06-26 15:01:36",
            "data_criacao": "2025-06-26 14:48:09",
            "username_criacao": "Teste"
        },
        {
            "id": 19483972,
            "cod_interno": "00013",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_009",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "21050010",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "21050010",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": "Teste",
            "fundamentacao": null,
            "dt_classificacao": "2025-08-28 11:23:20",
            "data_criacao": "2025-08-28 11:19:41",
            "username_criacao": "Teste"
        },
        {
            "id": 19483985,
            "cod_interno": "00004-900",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Produto_Teste_010",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "25231000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "25231000",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": "Teste",
            "fundamentacao": null,
            "dt_classificacao": "2025-08-28 11:39:48",
            "data_criacao": "2025-08-28 11:38:54",
            "username_criacao": "Teste"
        },
        {
            "id": 19484001,
            "cod_interno": "SYS_536163",
            "origem_produto": 0,
            "ean": "8880000887281",
            "descricao": "Produto_Teste_011",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "83014000",
            "ex_tipi_original": "",
            "ncm_sugerida": "83014000",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "83014000",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "classificado",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": null,
            "fundamentacao": null,
            "dt_classificacao": null,
            "data_criacao": "2025-08-28 12:01:03",
            "username_criacao": "Teste"
        },
        {
            "id": 19511913,
            "cod_interno": "00001",
            "origem_produto": 0,
            "ean": "76840002603",
            "descricao": "Teste",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "21050010",
            "ex_tipi_original": "10",
            "ncm_sugerida": "21050010",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "aguardando-ncm-definitiva",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": null,
            "fundamentacao": null,
            "dt_classificacao": null,
            "data_criacao": "2025-09-12 11:30:42",
            "username_criacao": "Teste"
        },
        {
            "id": 19511999,
            "cod_interno": "000002",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Teste_002",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "",
            "ex_tipi_definitiva": "",
            "cest": "1711100",
            "status_atual": "novo",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": null,
            "fundamentacao": null,
            "dt_classificacao": null,
            "data_criacao": "2025-09-12 11:36:38",
            "username_criacao": "Teste"
        },
        {
            "id": 19512000,
            "cod_interno": "000003",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Teste_003",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "85049090",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "",
            "ex_tipi_definitiva": "",
            "cest": null,
            "status_atual": "novo",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": null,
            "fundamentacao": null,
            "dt_classificacao": null,
            "data_criacao": "2025-09-12 11:36:39",
            "username_criacao": "Teste"
        },
        {
            "id": 19512001,
            "cod_interno": "000004",
            "origem_produto": 0,
            "ean": "",
            "descricao": "Teste_004",
            "descricao_sugerida": "",
            "complemento": "",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "",
            "ex_tipi_definitiva": "",
            "cest": "1711100",
            "status_atual": "novo",
            "username_classificacao": null,
            "duvida_tecnica": null,
            "resposta_tecnica": null,
            "fundamentacao": null,
            "dt_classificacao": null,
            "data_criacao": "2025-09-12 11:36:39",
            "username_criacao": "Teste"
        }
    ]
}

Exemplo - Consulta por NCM

Endpoint: http://app.systax.com.br/cfm/products/?por_pagina=3&tipo_retorno=ncm&order_by=data_criacao.ASC

Response

{
    "produtos": [
        {
            "id": "18893817",
            "cod_interno": "00004-900",
            "origem_produto": "1",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "25231000",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "25231000",
            "ex_tipi_definitiva": "",
            "status_atual": "classificado"
        },
        {
            "id": "18893820",
            "cod_interno": "00117000611",
            "origem_produto": "1",
            "ncm_original": "22021000",
            "ex_tipi_original": "",
            "ncm_sugerida": "22021000",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "73181600",
            "ex_tipi_definitiva": "",
            "status_atual": "classificado"
        },
        {
            "id": "18893831",
            "cod_interno": "00117000612",
            "origem_produto": "1",
            "ncm_original": "87089990",
            "ex_tipi_original": "",
            "ncm_sugerida": "87089910",
            "ex_tipi_sugerida": "",
            "ncm_definitiva": "",
            "ex_tipi_definitiva": "",
            "status_atual": "novo"
        }
    ],
    "paginacao": {
        "total_registros": 15,
        "num_paginas": 5,
        "por_pagina": 3,
        "pagina_atual": 1,
        "itens_da_pagina": 3
    },
    "success": true,
    "message": "ok"
}

Exemplo - Consulta por Dúvida Técnica

Endpoint: http://app.systax.com.br/cfm/products/?por_pagina=3&tipo_retorno=duvida&order_by=data_criacao.DESC

Response

{
    "produtos": [
        {
            "id": "19512001",
            "cod_interno": "000004",
            "origem_produto": "0",
            "duvida_tecnica": "",
            "resposta_tecnica": "Resposta Teste"
        },
        {
            "id": "19512000",
            "cod_interno": "000003",
            "origem_produto": "0",
            "duvida_tecnica": "",
            "resposta_tecnica": "Resposta Teste"
        },
        {
            "id": "19511999",
            "cod_interno": "000002",
            "origem_produto": "0",
            "duvida_tecnica": "",
            "resposta_tecnica": "Resposta Teste"
        }
    ],
    "paginacao": {
        "total_registros": 15,
        "num_paginas": 5,
        "por_pagina": 3,
        "pagina_atual": 1,
        "itens_da_pagina": 3
    },
    "success": true,
    "message": "ok"
}