Agora no Bluesoft ERP, é possível consultar os pedidos de venda aplicando filtros opcionais por tipo de entrega e por número de pedido externo via API.

O objetivo desta melhoria é permitir que os sistemas integradores consultem pedidos de forma mais precisa diretamente na API, eliminando a necessidade de buscar uma lista ampla de registros para filtragem manual e processamento adicional fora do ERP, reduzindo significativamente o volume de dados trafegados.

Como Irá Funcionar a Partir de Agora?

A API pública de consulta de pedidos balcão foi evoluída para incluir um novo campo no objeto principal do retorno e aceitar dois novos parâmetros opcionais de busca.

1. Alteração no Retorno da API

Cada pedido listado no retorno da API passará a conter o seguinte campo no objeto principal:

  • tipoDeEntrega (string): Retorna o valor textual exato salvo no pedido de venda (PEDIDO_VENDA.TIPO_DE_ENTREGA). Os valores possíveis são RETIRA_NA_LOJA ou ENTREGA_NO_CEP. Quando o tipo de entrega não for informado na origem do pedido, o sistema assumirá o valor padrão RETIRA_NA_LOJA.

2. Novos Filtros Disponíveis

A API passa a aceitar os seguintes parâmetros de consulta na URL (Query Params):

  • tipoDeEntrega (string, opcional): Permite filtrar os pedidos de forma exata pelos valores RETIRA_NA_LOJA ou ENTREGA_NO_CEP. Caso o parâmetro seja enviado com um valor diferente destes, a consulta será rejeitada com uma mensagem de erro impeditivo.
  • numeroPedidoExterno (string, opcional): Permite filtrar de forma exata por valores alfanuméricos (letras e números) correspondentes ao identificador externo do pedido. A busca não trará resultados parcialmente compatíveis.

3. Combinação de Filtros e Compatibilidade

  • Os novos filtros podem ser combinados entre si e com os demais filtros já existentes na API. Quando informados juntos, o sistema retornará apenas os registros que atenderem simultaneamente a todos os critérios.
  • Caso os filtros combinados não encontrem correspondência, a API retornará uma lista vazia no campo data ([]), sem gerar erro no processamento.
  • Se os novos parâmetros não forem utilizados na requisição, o comportamento atual da API é integralmente preservado , garantindo total compatibilidade para os consumidores atuais da integração.

Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.

Para saber mais sobre a utilização das APIs do ERP, clique aqui.

Disponível a partir da versão r368.56