YOM Docs

Untitled

Untitled

Untitled

Stock

Creados tus Productos, es posible indicar su Stock disponible.

La entidad Stock permite gestionar la disponibilidad de Productos en los distintos Centros de Distribución. Los campos asociados a esta entidad incluyen el nombre del Centro de Distribución, el identificador único del Producto y la cantidad disponible en Stock.

¿Porque y como se usan el stock?

El stock se utiliza en la app de ventas. Su principal objetivo es que el vendedor tenga información para saber si un producto tiene riesgo de quiebre de stock al venderse. El stock se modela de tal forma que está asociado a un centro de distribución, y por otra parte, también existe una asociación entre comercios y centros de distribución. En general, se manejan dos casos: uno en el que cada comercio tiene un único centro de distribución, o el caso en que tiene varios centros de distribución. Esto responde al caso de si se quiere ver un stock único o si se quiere ver el stock de varios lugares.

El stock tiene 4 características importantes: una referencia a un producto, una referencia al centro de distribución, el nombre del centro de distribución y la cantidad de stock.

La configuración de stock soporta dos casos. uno en que un comercio tiene un unico centro de distribucion y este se muestra directamente en la tarjeta del producto dentro de la app. Y el caso en que un comercio tenga varios centros de distribucion lo que implica que para ver el stock es necesario apretar un boton de ver stock que muestra el listado de los stocks de todos los centros de distribucion asociados. En este caso se puede configurar que los comercios tengan todos los centros de distribucion asocidados sin tener que explicitarlo.

Endpoint

GET /api/stock

Campos

Campo Tipo Carácter Descripción Ejemplos
productId 📝 Texto 🟢 Requerido Identificador único del producto. "SKU001"
distributionCenterId 📝 Texto 🟢 Requerido Identificador único del Centro de Distribución.
Centro de Distribución "CD27"
distributionCenterName 📝 Texto 🟡 Recomendado Nombre del Centro de Distribución.
Centro de Distribución "Centro de Distribución Norte"
quantity 🔢 Número 🟢 Requerido Cantidad disponible en stock. 150

Respuesta

La respuesta del endpoint de Stock proporciona un JSON con la información detallada de la disponibilidad de Productos en los distintos Centros de Distribución.

Ejemplo de Respuesta

{
  "productId": "SKU001",
  "distributionCenterId": "CD27",
  "distributionCenterName": "Centro de Distribución Norte",
  "quantity": 150
}

Esta estructura permite gestionar y consultar la disponibilidad de Stock en YOM de manera eficiente.

Pasos anteriores

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Centro de Distribución

</aside>

Siguientes pasos

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Sobrescrituras

</aside>

Tabla de contenidos