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
Authentication
Path Parameters
Headers
Consulta em lote - Solicitar.
Solicita o processamento assíncrono da consulta de tributação de uma lista de produtos em lote.
🔄 PROCESSAMENTO: A consulta é processada de forma assíncrona. Utilize o identificador retornado para acompanhar o andamento através do endpoint de consulta.
📋 FILTROS: Cada item da lista pode ser identificado por EAN, descrição similar ou hash. Todos os filtros são processados individualmente e o resultado de cada um fica disponível na consulta do lote.
🔔 CALLBACK: Informe uma URL de callback para receber uma notificação automática assim que o processamento for concluído. O payload enviado seguirá o mesmo contrato do endpoint de consulta.
⚠️ ATENÇÃO: Só é permitida uma consulta em lote em andamento por emissor. Aguarde a conclusão antes de solicitar uma nova.
post
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Body
Body
Dados da solicitação de consulta em lote.
SolicitarConsultaEmLoteInputModel
Dados para solicitação de consulta de tributação de produtos em lote de forma assíncrona.
* Additional properties are NOT allowed.
filtrosarray[object]required
Filtro individual para consulta de tributação de produto em lote.
>= 1 items
* Additional properties are NOT allowed.
Show Child Parameters
perfilTributarioobject
Perfil tributário opcional para a consulta de tributação em lote.
Se não informado, serão utilizados os valores padrão (venda para consumidor final presencial).
* Additional properties are NOT allowed.
Show Child Parameters
urlCallbackstring | null
URL de callback para notificação após a conclusão do processamento.
Response
Response
OK
string(uuid)
post/api/v1/CatalogoProduto/ConsultaEmLote/Solicitar
Authentication
Headers
Body
{
"filtros": [
{
"filtro": "filtro"
}
]
}
Consulta em lote - Consultar solicitação.
Permite o acompanhamento do processamento de uma solicitação de consulta em lote previamente realizada.
🔄 ESTADOS: A solicitação pode transitar entre os estados Pendente, EmProcessamento e Concluido. Os resultados individuais de cada filtro só estarão disponíveis quando o status for Concluido.
📋 RESULTADOS: Cada filtro possui seu próprio status de processamento (Pendente, Sucesso ou Falha). Em caso de falha em um filtro específico, os demais não são impactados.
get
Path Parameters
consultaLoteIdstring(uuid)required
Identificador único da solicitação de consulta em lote.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ConsultaEmLoteViewModel
Dados da solicitação de consulta de tributação de produtos em lote.
* Additional properties are NOT allowed.
idstring(uuid)
Identificador da solicitação.
statusstring
Status da consulta de tributação de produtos em lote.
Allowed values:PendenteEmProcessamentoConcluido
dataSolicitacaostring(date-time)
Data de criação da solicitação.
dataHoraProcessamentostring | null(date-time)
Data e hora de início do processamento.
perfilTributarioobject
Perfil tributário utilizado na consulta em lote.
* Additional properties are NOT allowed.
Show Child Parameters
filtrosarray | null[object]
Resultado de um filtro individual da consulta de tributação de produtos em lote.
* Additional properties are NOT allowed.
Show Child Parameters
urlCallbackstring | null
URL de callback para notificação de conclusão.
statusCallbackstring
Status do callback de notificação da consulta de tributação de produtos em lote.
Allowed values:NaoRealizadoSucessoFalha
mensagemFalhaCallbackstring | null
Mensagem de falha do callback, quando aplicável.
get/api/v1/CatalogoProduto/ConsultaEmLote/{consultaLoteId}
Authentication
Path Parameters
Headers
Produtos consultados - Listar.
Permite a listagem e gestão dos produtos que já foram objeto de consulta pelo Emissor.
Esta funcionalidade facilita a sincronização de portfólios, permitindo filtrar registros por identificadores
técnicos ou períodos específicos de atualização.
🔍 CRITÉRIOS DE BUSCA: O campo de busca permite localizar registros de forma flexível, aceitando tanto
o HASH de identificação fiscal quanto os termos originais (EAN ou descrição) utilizados no momento da consulta.
📅 ATUALIZAÇÃO FISCAL: Utilize os filtros de data para identificar quais itens do seu catálogo local
podem necessitar de revisão com base na última análise fiscal realizada pela plataforma.
get
Query Parameters
buscastring
Filtrar pelo hash de identificação ou pelo filtro utilizado na consulta.
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)
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
ListarProdutosEmissorViewModelListPaginationResponse
* Additional properties are NOT allowed.
offsetinteger(int32)
limitinteger(int32)
totalinteger(int32)
dataarray | null[object]
Dados do produto do emissor.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/CatalogoProduto/Produto/Listar
Authentication
Query Parameters
Headers
Produtos consultados - Detalhe.
Permite obter a visão detalhada de um produto específico presente no catálogo do Emissor,
utilizando seu identificador único gerado pela plataforma.
📋 INFORMAÇÕES RETORNADAS: O retorno abrange desde os dados cadastrais básicos (EAN, Descrição, NCM)
até o histórico de bilhetagem aplicada sobre o produto.
💡 UTILIZAÇÃO: Este endpoint é ideal para obter o histórico de bilhetagem do produto.
get
Path Parameters
produtoEmissorIdstring(uuid)required
Identificador interno do produto do emissor.
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ProdutoEmissorViewModel
Dados detalhados do produto relacionado ao emissor.
* Additional properties are NOT allowed.
idstring(uuid)
Identificador interno do produto do emissor.
hashstring | null
Hash de identificação da tributação.
filtrostring | null
Filtro usado na consulta para identificar o produto.
ultimaConsultastring(date-time)
Data da última consulta realizada.
ultimaAtualizacaoFiscalstring | null(date-time)
Data da última atualização fiscal.
bilhetagemarray | null[object]
Dados da bilhetagem do produto.
* Additional properties are NOT allowed.
Show Child Parameters
get/api/v1/CatalogoProduto/Produto/{produtoEmissorId}/ObterDetalhe