Hash de produtos - Buscar.
Permite localizar o identificador único (HASH) de tributação de mercadorias através de sua descrição comercial.
🔗 UTILIZAÇÃO: Este endpoint é fundamental para identificar o vínculo correto de um produto quando o EAN (GTIN) não está disponível, permitindo que o sistema consumidor armazene o HASH para futuras consultas de atualização tributária.
🔍 CRITÉRIO DE BUSCA: A busca é processada por algoritmos de similaridade. Recomenda-se o envio de descrições claras e sem abreviações excessivas para garantir que a listagem de hashes retornada seja condizente com o item desejado.
get
Query Parameters
descricaostring
Descrição comercial ou termo de busca para localizar o produto.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
Dados exibidos na listagem da busca de hash de produtos no catálogo fiscal.
* Additional properties are NOT allowed.
hashstring | null
Hash do produto.
descricaostring | null
Descrição do produto.
ncmstring | null
Ncm do produto.
ceststring | null
Cest do produto.
grupostring | null
Descrição do grupo do produto.
get/api/v1/CatalogoProduto/BuscarHash
Authentication
Query Parameters
Headers
Tributos atualizados - Listar.
Fornece uma lista de produtos cuja tributação sofreu atualização no intervalo de tempo fornecido em filtro. Com base no retorno, o sistema consumidor do serviço deverá utilizar o HASH salvo para atualizar os tributos consultados anteriormente.
get
Query Parameters
hashstring
Filtrar pelo hash de identificação.
ultimaAtualizacaoFiscalInicialstring(date-time)
Filtrar pela data de atualização fiscal “a partir de”.
ultimaAtualizacaoFiscalFinalstring(date-time)
Filtrar pela data de atualização fiscal “até”.
offsetinteger(int32)
Registro inicial para paginação.
Default:1
limitinteger(int32)
Quantidade de registros por página.
Default:10
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ListarTributacaoAlteradaViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados da tributação alterada.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/CatalogoProduto/ListarTributacaoAlterada
Authentication
Query Parameters
Headers
Histórico de consultas - Resumo.
Fornece dados totalizados do histórico de consultas na api. Permite ao usuário fazer o acompanhamento da bilhetagem de consumo dos serviços filtrando por intervalo de datas ou texto de busca genérica.
get
Query Parameters
modoConsultastring
Tipo de consulta realizada pelo emissor.
Allowed values:ConsultaProdutoEmissaoDeNotaFiscal
tipoFiltrostring
Tipo de filtro do catálogo de produto.
Allowed values:EanDescricaoSimilarHash
buscastring
Busca genérica - Filtro ou Hash.
statusConsultastring
Status de retorno da consulta do produto.
Allowed values:SucessoNaoEncontradoFalha
dataConsultaInicialstring(date-time)
Filtrar pela data de consulta “a partir de”.
dataConsultaFinalstring(date-time)
Filtrar pela data de consulta “até”.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ResumoConsultasProdutoVisaoAplicacaoViewModel
Dados do resumo da consulta realizada pelo emissor exibidos na aplicação.
* Additional properties are NOT allowed.
totalConsultasinteger(int32)
Total de consultas realizadas pelo emissor.
totalSucessointeger(int32)
Total de consultas concluídas com sucesso.
totalNaoEncontradointeger(int32)
Total de consultas cujo produto não foi encontrado.
totalFalhainteger(int32)
Total de consultas que apresentaram falhas no processo.
get/api/v1/CatalogoProduto/Historico/Resumo
Authentication
Query Parameters
Headers
Histórico de consultas - Listar.
Permite listar o histórico de consultas realizadas na api. Fornece filtros não obrigatórios por intervalo de datas ou texto de busca genérica.
get
Query Parameters
modoConsultastring
Tipo de consulta realizada pelo emissor.
Allowed values:ConsultaProdutoEmissaoDeNotaFiscal
tipoFiltrostring
Tipo de filtro do catálogo de produto.
Allowed values:EanDescricaoSimilarHash
buscastring
Busca genérica - Filtro ou Hash.
statusConsultastring
Status de retorno da consulta do produto.
Allowed values:SucessoNaoEncontradoFalha
dataConsultaInicialstring(date-time)
Filtrar pela data de consulta “a partir de”.
dataConsultaFinalstring(date-time)
Filtrar pela data de consulta “até”.
offsetinteger(int32)
Paginação da listagem - página atual.
Default:1
limitinteger(int32)
Paginação da listagem - itens por página.
Default:10
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ListarConsultasProdutoVisaoAplicacaoViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados detalhados da listagem de consultas do emissor exibidos pela aplicacao.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/CatalogoProduto/Historico/Listar
Authentication
Query Parameters
Headers
Histórico de consultas - Detalhe.
Permite obter o detalhe da consulta realizada com base no ID da listagem do histórico.
get
Path Parameters
historicoConsultaEmissorIdstring(uuid)required
Identificador do histórico de consulta do emissor.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
DetalheConsultasProdutoVisaoAplicacaoViewModel
Dados detalhados da consulta realizada pelo emissor exibidos pela aplicação.
* Additional properties are NOT allowed.
idstring(uuid)
Identificador interno da consulta no histórico.
modoConsultastring
Tipo de consulta realizada pelo emissor.
Allowed values:ConsultaProdutoEmissaoDeNotaFiscal
tipoFiltrostring
Tipo de filtro do catálogo de produto.
Allowed values:EanDescricaoSimilarHash
filtrostring | null
Valor do filtro utilizado.
dataConsultastring(date-time)
Data da consulta.
parametrosConsultastring | null
Parâmetros detalhados da consulta.
statusConsultastring
Status de retorno da consulta do produto.
Allowed values:SucessoNaoEncontradoFalha
hashstring | null
Hash do resultado da consulta.
jsonResultadoInformadostring | null
JSON contendo o resultado informado.
bilhetadoboolean
Indica se a consulta foi bilhetada.
get/api/v1/CatalogoProduto/Historico/{historicoConsultaEmissorId}/ObterDetalhe