Skip to main content

Informações

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

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

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

Request consuntando NCM

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

Request consultando dúvida:

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

 

Request e Response

API Classificação Fiscal - Informações (Imagem 1).jpg