Guias
Novidades
Atualizações recentes da API Consultiva.
Setembro de 2026
- Situação do produto por loja: o campo
ativopassou a refletir a situação do produto na loja consultada, conforme exibido na tela de produto dessa loja. - Nome do cliente da ótica na O.S.: nas ordens de serviço de laboratório, o campo
cliente_otica(nome do cliente da ótica que enviou o pedido) passou a ser retornado vazio quando a ótica não autoriza a exibição do nome. - Data da última compra do produto: novo campo
data_ultima_compra, com a data da última compra do produto na loja. - Paginação: corrigida a situação em que registros com a mesma data podiam ser repetidos em uma página e omitidos em outra. Agora, cada registro é retornado uma única vez.
Agosto de 2026
- Limite de 60 requisições por minuto por loja. Ao exceder o limite, a API retorna
429. Consulte Paginação e limites. - Novo erro
API_NAO_CONTRATADA, retornado quando o contrato da loja não inclui a API (anteriormente,ERRO_INTERNO). - Ordens de serviço: novos campos
cliente_otica(nas O.S. de laboratório, nome do cliente da ótica) eformato_armacao.
Julho de 2026
- Intervalo de até 180 dias por consulta (anteriormente, cerca de 30).
- Paginação opcional nas consultas de vendas, extrato, lançamentos de caixa e ordens de
serviço, por meio de
pageeperPage. Sem esses parâmetros, a resposta continua trazendo a lista completa. - Filtro
statusnas ordens de serviço. - Códigos de erro específicos: os códigos genéricos
MISSING_PARAMETEReERRORforam substituídos por códigos comoDATA_INVALIDAePERIODO_OBRIGATORIO, mantendo o formato{ "error", "error_info" }. Nas consultas financeiras, períodos com data inicial posterior à final passaram a ser recusados. A lista completa está em Conceitos.
Atualizações anteriores
- Busca avançada de produtos: filtros por texto, grupo, grife, fornecedor, estoque e preço;
ordenação (
ordenar_por,direcao) e resposta reduzida (fields=basico). - Listagens: clientes, funcionários e formas de pagamento.
- Saldos das contas: saldo de cada conta em uma data de referência.
- Contas a pagar: campo
ocorrencias, com o histórico de inclusão, edição e exclusão de cada parcela.