Agora no Bluesoft ERP, é possível consultar os itens com quantidade zerada nos pedidos de compra com distribuição do tipo DSD (Direto nas Lojas) por meio do endpoint da API GET /api/compras/pedidos-de-compra.

Objetivo

O objetivo desta melhoria é permitir que integradores e sistemas de terceiros tenham maior visibilidade dos itens vinculados ao pedido de compra, incluindo aqueles que ainda não possuem quantidades digitadas, viabilizando sua gestão, análise e aprovação para posterior atualização sistêmica.

Como Era o Processo Antes?

Antes: Ao consultar a API de Pedidos de Compra, o sistema retornava exclusivamente os itens que possuíam quantidades maiores que zero. Os produtos com quantidade zerada não eram apresentados na resposta, limitando a visibilidade dos itens vinculados ao pedido para integrações responsáveis pela gestão e digitação de quantidades.

Agora: Foi adicionado um novo parâmetro opcional à requisição, permitindo solicitar a inclusão dos itens com quantidade pedida igual a zero nos pedidos com distribuição DSD (Direto nas Lojas), preservando o comportamento anterior quando a opção não for utilizada.

Benefícios:

  • Maior visibilidade dos itens vinculados aos pedidos de compra DSD, incluindo aqueles com quantidade pedida igual a zero.
  • Autonomia para aplicações terceiras realizarem a gestão, análise e aprovação de quantidades dos pedidos.
  • Preservação da identificação individual dos itens, produtos e lojas, permitindo o tratamento das quantidades conforme suas respectivas entregas.
  • Manutenção da compatibilidade com as integrações existentes: requisições que não informarem o novo parâmetro continuarão apresentando o comportamento anterior.

Como Irá Funcionar a Partir de Agora?

Na consulta pelo método GET /api/compras/pedidos-de-compra, foi disponibilizado o novo parâmetro de consulta opcional incluirItensComQuantidadeZero.

Para incluir os itens com quantidade zerada na resposta, o integrador deverá enviar o parâmetro incluirItensComQuantidadeZero=true na URL da requisição. Exemplo: GET /api/compras/pedidos-de-compra?incluirItensComQuantidadeZero=true

Ao receber a requisição com o parâmetro habilitado, o ERP retornará os itens elegíveis vinculados aos pedidos DSD, incluindo aqueles cuja quantidade pedida seja exatamente igual a zero. A consulta preservará a identificação individual de cada item, produto e loja, sem consolidar quantidades entre lojas ou entregas. Os itens com quantidades positivas continuarão sendo retornados normalmente. Itens com quantidades negativas não serão incluídos por essa opção.

Caso o parâmetro seja enviado como false ou seja omitido, a API continuará retornando exclusivamente os itens com quantidade pedida maior que zero. Para pedidos com distribuição diferente de DSD, o envio de incluirItensComQuantidadeZero=true não acrescentará itens zerados, mantendo o comportamento anterior. Quando a consulta não possuir filtro por tipo de distribuição, os pedidos das diferentes modalidades continuarão elegíveis para o retorno, respeitando os filtros informados. Somente os pedidos DSD terão seus itens zerados acrescentados à listagem.

O parâmetro aceitará exclusivamente os valores true ou false, em letras minúsculas, informados uma única vez na requisição. Caso seja enviado um valor inválido, vazio ou duplicado, a API retornará o status HTTP 400 Bad Request, com uma resposta estruturada de validação associada ao parâmetro incluirItensComQuantidadeZero. A mensagem de validação será: Informe true ou false uma única vez.

Observações Importantes!

  • Exclusividade DSD: A inclusão de itens com quantidade zerada ocorre exclusivamente nos pedidos com distribuição DSD (Direto nas Lojas). As demais modalidades de distribuição continuarão apresentando apenas os itens com quantidade pedida maior que zero.
  • Permissão de Acesso: A consulta continuará exigindo a permissão 3122 – API Pedidos Efetivados (Consultar). O novo parâmetro não altera as regras existentes de autenticação ou autorização.
  • Somente Leitura: Esta melhoria atua exclusivamente na consulta dos dados. Não serão criados novos produtos ou itens, nem realizadas alterações nas quantidades ou na situação dos pedidos durante a requisição. A atualização das quantidades continuará sendo realizada pela operação específica PATCH /api/compras/pedidos-de-compra/{numeroDoPedido}, respeitando suas próprias validações e regras de negócio.
  • Preservação do Indicador de Entrega: A inclusão dos itens zerados não modificará o comportamento esperado do indicador entregaPendente. Nos pedidos fechados, o indicador continuará considerando a existência de pendências nos itens cuja quantidade pedida seja maior que zero. Dessa forma, itens com quantidade pedida igual a zero poderão apresentar quantidadePendente positiva sem interferir no resultado de entregaPendente. Nos pedidos que não estiverem fechados, o indicador continuará seguindo a regra existente para a situação do pedido.
  • Preservação de Regras: Os filtros existentes, a paginação, os formatos da resposta e a ausência de totalizadores permanecerão inalterados.O recorte temporal padrão de sete dias continuará sendo aplicado nas condições já existentes, quando não forem informados o número do pedido, a data inicial de atualização ou a data de emissão. O filtro de loja continuará sendo aplicado aos pedidos e respectivos itens retornados, sem alterar as permissões de acesso.

Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui: API Pedido de Compra

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

Disponível a partir da versão r375.01