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
Authentication
Path Parameters
Headers
Nfe
Controlador de Notas Fiscais Eletrônicas (NFe) da Stone Tax API.
Centraliza os recursos destinados à emissão, cancelamento e gestão de notas fiscais eletrônicas (NFe).
Fornece abstrações para simplificar a complexidade de comunicação com as Secretarias da Fazenda (SEFAZ).
Através desta controller, é possível gerenciar todo o ciclo de vida de um documento fiscal: desde a emissão até a obtenção de artefatos finais como o XML e o DANFE.
Operações de escrita (emissão/cancelamento) exigem assinatura digital e observância ao contexto do
Emissor configurado, garantindo a validade jurídica perante o Fisco.
Status SEFAZ.
Realiza a verificação em tempo real da disponibilidade dos serviços da SEFAZ (Secretaria da Fazenda) para a autorização de documentos fiscais.
Este recurso é essencial para diagnosticar instabilidades no webservice de destino, permitindo que o sistema emissor decida pela ativação de regimes de contingência ou aguarde a normalização do serviço.
⚠️ ATENÇÃO: O tempo de resposta deste endpoint depende diretamente da latência do servidor governamental consultado. Recomenda-se implementar um timeout adequado no lado do cliente para evitar retenção de threads.
🧪 TESTE: Em ambiente de sandbox, o retorno pode simular um status de “Operação Normal” de forma estática ou refletir o ambiente de homologação da SEFAZ, dependendo da configuração da aplicação.
post
Headers
DocumentoEmissorstringrequired
Documento do emissor.
Response
Response
OK
ConsultarStatusSefazViewModel
Retorno da consulta de status da SEFAZ.
* Additional properties are NOT allowed.
sucessoboolean
Indica se a consulta foi bem sucedida.
tipoAmbientestring
Tipo de ambiente da SEFAZ.
Allowed values:ProducaoHomologacao
ufstring
Lista de Unidades Federativas para Nota Fiscal.
Allowed values:ROACAMRRPAAPTOMAPICERNPBPEALSEBAMGESRJSPPRSCRSMSMTGODF
cStatinteger(int32)
Código de status da SEFAZ.
xMotivostring | null
Motivo do status da SEFAZ.
post/api/v1/Nfe/Sefaz/Status