A ferramenta de Saldos do Produto (get_stock_balance_by_product) fornece informações sobre o saldo atual de um produto. Opcionalmente, são apresentadas as informações dos lotes do produto, caso o produto possua controle por lote e seja realizada a pesquisa para um armazém ou código de lote específico.
Esta ferramenta é capaz de interagir com solicitações semelhantes a:
Esta ferramenta utiliza os seguintes argumentos para sua execução:
| Argumento | Descrição | Obrigatório? |
|---|---|---|
| product_code | Código do produto para busca dos saldos | Sim |
| warehouse_code_optional | Código do armazém para busca dos saldos | Não |
| lot_code_optional | Código do lote para filtrar os saldos | Não |
A ferramenta irá retornar as informações a seguir:
| Cabeçalho | ||
|---|---|---|
| Campo | Descrição | Origem da informação |
| product_code | Código do produto | B1_COD |
| product_description | Descrição do produto | B1_DESC |
| product_unit_measure | Unidade de medida do produto | B1_UM |
| total_stock_balance | Soma do saldo em estoque em todos os armazéns | Soma de B2_QATU |
| total_quantity_to_address | Soma da quantidade do produto pendente de endereçamento em todos os armazéns | Soma de B2_QACLASS |
| items | Lista de saldos por armazém | Lista de armazéns |
| Lista de saldos por armazém (items) | ||
|---|---|---|
| Campo | Descrição | Origem da informação |
| warehouse_code | Código do armazém | B2_LOCAL |
| warehouse_description | Descrição do armazém | NNR_DESCRI |
| stock_balance | Saldo em estoque | B2_QATU |
quantity_to_address | Quantidade do produto pendente de endereçamento | B2_QACLASS |
| lots | Lista de lotes do produto | Lista de lotes do produto |
| Lista de lotes do produto (lots) | ||
|---|---|---|
| Campo | Descrição | Origem da informação |
| lot_code | Código do lote | B8_LOTECTL |
| quantity_in_lot | Saldo em estoque do lote | B8_SALDO |
| expiration_date | Vencimento do lote | B8_DTVALID |
A consulta somente será irá apresentar informações de lote para produtos que possuem controle de lote (B1_RASTRO igual à "L"). Produtos que controlem sublote ou que não possuam controle de lote não terão informações na Lista de lotes do produto.
Os dados da Lista de lotes do produto somente são apresentados quando a consulta for realizada utilizando o filtro de código de armazém ou o filtro de código de lote. Ao realizar a busca somente pelo código do produto, os dados de lote do produto não serão exibidos.
As informações sobre os totais em estoque (total_stock_balance e total_quantity_to_address) possuem as quantidades de todos os armazéns, independente dos filtros solicitados de código de armazém ou código de lote.