Estoque
Atualizações de estoque com fila de processamento, claim atômico e reindex relativo — projetadas para cenários de alto volume.
Visão geral
O endpoint de estoque foi reforçado para maior robustez em cenários de alto volume, com processamento em fila e reindex relativo. A atualização aceita identificação por SKU ou por ID, conforme o campo type.
A mesma rota passou a atender também a consulta somente leitura da configuração de estoque de um produto, incluindo a disponibilidade efetiva para venda.
Consultar estoque do produto Novo
Operação somente leitura: não altera estoque, não cria fila, não salva produto e não executa reindexação.
Consultar a configuração de estoque de um produto por SKU ou por ID.
GET /api2/stock?id=3291&type=sku
Authorization: Bearer {access_token}GET /api2/stock?id=2074&type=id
Authorization: Bearer {access_token}GET /api2/stock?id=3291&type=sku&store_id=1&customer_group_id=0
Authorization: Bearer {access_token}Parâmetros
type.id é interpretado: id ou sku.0.Exemplo de resposta
{
"success": true,
"product_id": 2074,
"sku": "3291",
"type": "simple",
"context": {
"store_id": 1,
"website_id": 1,
"customer_group_id": 0,
"store": {"id": 1, "code": "default", "name": "Português (Brasil)"},
"website": {"id": 1, "code": "cafe", "name": "Website Principal"},
"customer_group": {"id": 0, "name": "Visitante"}
},
"inventory": {
"inventory_manage_stock": true,
"inventory_use_config_manage_stock": true,
"inventory_qty": "38.0000",
"inventory_min_qty": "0.0000",
"inventory_use_config_min_qty": true,
"inventory_min_sale_qty": null,
"inventory_use_config_min_sale_qty": true,
"inventory_max_sale_qty": "10000.0000",
"inventory_use_config_max_sale_qty": true,
"inventory_is_qty_decimal": false,
"inventory_backorders": "none",
"inventory_use_config_backorders": true,
"inventory_notify_stock_qty": "1.0000",
"inventory_use_config_notify_stock_qty": true,
"inventory_enable_qty_increments": false,
"inventory_use_config_enable_qty_increments": true,
"inventory_qty_increments": null,
"inventory_use_config_qty_increments": true,
"inventory_stock_availability": "in_stock",
"inventory_stock_availability_label": "Em Estoque",
"inventory_is_salable": true
}
}Mapeamento com a Plataforma Yep
| Campo na Plataforma Yep | Campo REST |
|---|---|
| Gerenciar Estoque | inventory_manage_stock |
| Qtd | inventory_qty |
| Marcar como Esgotado Quando Qtd Chegar a | inventory_min_qty |
| Qtd Mínima Permitida no Carrinho | inventory_min_sale_qty |
| Qtd Máxima Permitida no Carrinho | inventory_max_sale_qty |
| Qtd Usos Decimais | inventory_is_qty_decimal |
| Pedido Aguardando Estoque | inventory_backorders |
| Avisar sobre Quantidade Baixa | inventory_notify_stock_qty |
| Habilitar Quantidade Incrementos | inventory_enable_qty_increments |
| Quantidade Incrementos | inventory_qty_increments |
| Disponibilidade de Estoque | inventory_stock_availability |
| Disponibilidade efetiva para venda | inventory_is_salable |
inventory_use_config_* indica se o valor é herdado da configuração geral. Quando o use_config está ativo, o campo principal representa o valor efetivamente utilizado pela Plataforma Yep.Disponibilidade: uma diferença importante
in_stock e out_of_stock, acompanhados de inventory_stock_availability_label (Em Estoque ou Esgotado).none, allow_below_zero e allow_below_zero_and_notify.Os dois campos não são sinônimos
É possível receber inventory_stock_availability: "in_stock" junto de inventory_is_salable: false. Isso não é uma inconsistência: o primeiro campo representa o estado cadastrado de estoque; o segundo representa a decisão efetiva da plataforma.
Produtos configuráveis
Para produtos do tipo configurable, inventory_qty: null é um resultado válido e esperado — a API não soma as quantidades dos produtos associados. Para saber a disponibilidade efetiva, utilize inventory_is_salable.
Valores null
Alguns valores herdados podem retornar null quando não houver uma configuração efetiva aplicável naquele contexto.
{
"inventory_min_sale_qty": null,
"inventory_use_config_min_sale_qty": true
}Respostas HTTP
| Situação | Status |
|---|---|
| Sucesso | 200 |
| Parâmetros inválidos | 400 |
| Sem autenticação ou token inválido | 401 |
| Sem permissão | 403 |
| Produto não encontrado | 404 |
| Falha interna | 500 |
Atualizar ou definir estoque por SKU ou ID.
{
"type": "sku",
"sku": "novo_produto",
"qty": 27,
"stock_id": 1
}type.Parâmetros
sku ou id.type=sku.