YOM Docs

Estoque

Criados seus Produtos, é possível indicar seu Estoque disponível.

A entidade Estoque permite gerenciar a disponibilidade de Produtos nos diferentes Centros de Distribuição. Os campos associados a esta entidade incluem o nome do Centro de Distribuição, o identificador único do Produto e a quantidade disponível em Estoque.

Por que e como se usa o estoque?

O estoque é utilizado no app de vendas. Seu principal objetivo é que o vendedor tenha informação para saber se um produto tem risco de ruptura de estoque ao ser vendido. O estoque é modelado de tal forma que está associado a um centro de distribuição e, por outro lado, também existe uma associação entre comércios e centros de distribuição. Em geral, são tratados dois casos: um em que cada comércio tem um único centro de distribuição, ou o caso em que tem vários centros de distribuição. Isso responde ao caso de se querer ver um estoque único ou de se querer ver o estoque de vários lugares.

O estoque tem 4 características importantes: uma referência a um produto, uma referência ao centro de distribuição, o nome do centro de distribuição e a quantidade de estoque.

A configuração de estoque suporta dois casos. Um em que um comércio tem um único centro de distribuição e este é mostrado diretamente no card do produto dentro do app. E o caso em que um comércio tenha vários centros de distribuição, o que implica que, para ver o estoque, é necessário apertar um botão de ver estoque que mostra a lista dos estoques de todos os centros de distribuição associados. Neste caso é possível configurar que os comércios tenham todos os centros de distribuição associados sem ter que explicitá-lo.

Endpoint

GET /api/stock

ARQUIVO <fecha>_<hora>_stock.csv

Campos

Campo Tipo Obrigatoriedade Descrição Exemplos
productId 📝 Texto 🟢 Obrigatório Identificador único do produto. "SKU001"
distributionCenterId 📝 Texto 🟢 Obrigatório Identificador único do Centro de Distribuição.
Centro de Distribuição "CD27"
distributionCenterName 📝 Texto ⚪ Opcional Nome do Centro de Distribuição.
Centro de Distribuição "Centro de Distribución Norte"
quantity 🔢 Número 🟢 Obrigatório Quantidade disponível em estoque. 150

Resposta

A resposta do endpoint de Estoque fornece um JSON com as informações detalhadas da disponibilidade de Produtos nos diferentes Centros de Distribuição.

Exemplo de Resposta

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

Esta estrutura permite gerenciar e consultar a disponibilidade de Estoque na YOM de maneira eficiente.

Etapas anteriores

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

</aside>