Stock Actual

Esta documentación se centra en las APIs diseñadas para la consulta de stock actual de artículos. Se han desarrollado dos APIs específicas: una destinada a recuperar una lista de todos los artículos y otra diseñada para consultar el stock de un artículo en particular.

URLs

Método Query

Este método se encarga de devolver el stock actual de los artículos disponibles en los distintos depósitos de la empresa.

¿Por qué dos APIs distintas?

La razón detrás de la creación de dos APIs separadas radica en consideraciones de rendimiento y en la optimización del uso de recursos del sistema.

  1. API para un solo artículo: Esta API se utiliza frecuentemente en interacciones con sitios de comercio electrónico. Aquí, es crucial especificar el código del artículo de interés para que la API devuelve exclusivamente los registros relacionados con ese artículo.
  2. API para todos los artículos: Al no indicarse un artículo específico, esta API puede devolver un conjunto significativamente grande de registros, distribuidos en páginas de hasta 500 registros por solicitud. Esta API solo devuelve artículos con un stock distinto de cero.

Ambas APIs tienen distintos rangos de ejecución debido al sistema que limita la cantidad de llamadas a cada API para evitar la sobrecarga y el consecuente fallo del sistema.

Se recomienda encarecidamente mantener una base de datos local con el stock de los artículos para evitar un uso excesivo de los recursos de la base de datos de ZetaSoftware. Esta precaución es especialmente relevante para la API que no posee un filtro de artículo, dado que su uso intensivo podría llevar al bloqueo automático de la API.

La eficiencia en la manipulación de APIs se ve ampliamente mejorada cuando se comprenden en profundidad los filtros y parámetros que estas ofrecen. A continuación se detallan los filtros disponibles para las APIs de consulta de stock de artículos.

Filtros Específicos para la API de un Sólo Artículo

Estos filtros son aplicables exclusivamente cuando se consulta el stock de un solo artículo. En la API que devuelve información de varios artículos, estos filtros no se utilizan.

  • ArticuloCodigo (T(20)): Este es el código del artículo del que se desea conocer el stock actual. Este filtro es obligatorio para esta API.
  • Lote (T(20)): Este filtro, aunque opcional, permite especificar el código del lote que se desea consultar.

Filtros Comunes para Ambas APIs

Los siguientes filtros son aplicables a ambas APIs:

  • VencimientoDesde (AAAA-MM-DD): Fecha mínima de vencimiento del artículo.
  • VencimientoHasta (AAAA-MM-DD): Fecha máxima de vencimiento del artículo.
  • DepositoCodigo (N(3)): Código del depósito en el cual se encuentra el artículo.
  • LocalCodigo (N(2)): Código del local donde se encuentra el artículo.
  • CantidadDesde (N(12.5)): Cantidad mínima del artículo que se desea consultar.
  • CantidadHasta (N(12.5)): Cantidad máxima del artículo que se desea consultar.
  • Page (N(2)): Es un parámetro obligatorio que controla la paginación de los resultados, mostrando 500 registros por página.

La API para todos los artículos, sólo tomará en cuenta aquellos artículos que están activos. Los artículos que no están activos serán ignorados por la API, tengan o no stock actual.

Resultados Esperados

Independientemente de la API utilizada, el conjunto de resultados retornados incluirá los siguientes campos:

  • ArticuloCodigo: Código del artículo consultado.
  • ArticuloNombre: Nombre del artículo.
  • ArticuloAbrevia: Abreviatura del nombre del artículo.
  • Lote: Código del lote del artículo.
  • Vencimiento: Fecha de vencimiento del artículo.
  • DepositoCodigo: Código del depósito donde se encuentra el artículo.
  • DepositoNombre: Nombre del depósito.
  • DepositoAbrevia: Abreviatura del nombre del depósito.
  • LocalCodigo: Código del local.
  • StockActual: Cantidad actual del artículo en stock.

Para desarrolladores, el entendimiento detallado de estos filtros es crucial. Por ejemplo, si están construyendo un sistema de gestión de inventario, podrían querer utilizar ArticuloCodigo para filtrar elementos específicos o usar DepositoCodigo y LocalCodigo para obtener información sobre la ubicación exacta de un artículo en un entorno de múltiples depósitos y locales.

Método StockActualModificado

La gestión de inventario a menudo requiere una actualización continua del estado de los artículos, particularmente aquellos cuyo stock ha cambiado recientemente. El método StockActualModificado surge como un complemento indispensable al método de consulta de stock general, centrando su funcionalidad en los artículos que han experimentado modificaciones en su stock desde la última consulta.

Filtro Disponible

A diferencia del método general de consulta de stock, StockActualModificado presenta un conjunto más reducido de filtros, simplificando su uso sin sacrificar su eficacia.

  • ArticuloCodigo (T(20)): Este filtro es opcional. Si se omite, la API devolverá la lista completa de artículos que han tenido alguna modificación en su stock desde la última consulta. Si se especifica un código de artículo, la consulta se centrará exclusivamente en ese artículo.

Resultados Esperados

Una vez realizada la consulta, el conjunto de resultados incluirá los siguientes campos:

  • DepositoCodigo: Identificador del depósito donde se encuentra el artículo.
  • ArticuloCodigo: Código del artículo consultado.
  • Lote: Identificador del lote asociado al artículo.
  • Vencimiento: Fecha de vencimiento del artículo.
  • Stock: Cantidad actual en stock del artículo.

Es importante subrayar que una vez consultada la API y obtenido el resultado, el estado del artículo en cuestión se marca como «no modificado», preparándolo para futuras consultas.

Este método resulta particularmente útil para escenarios donde se desea mantener una base de datos propia de inventario actualizada. Con StockActualModificado, los desarrolladores pueden optimizar las consultas de datos, reduciendo la cantidad de información transferida y procesada, y mejorando de este modo la performance del sistema de gestión de inventario que están desarrollando.


 

Compartir

Stock Actual

O copia el enlace

CONTENIDO