Atualização de estoque de produtos
PUT
/products/stocks
Atualiza o estoque de múltiplos produtos em lote.
Descrição
Responsável por executar a alteração de estoque nos produtos.
🔓 Permissão
Para utilizar este recurso, é necessário possuir o escopo de permissão: PRODUCT_STOCK_WRITE.
📋 Tipos de alteração de estoque
- Entrada (
"entry"): Adiciona a quantidade informada ao estoque atual do produto. - Saída (
"out"): Subtrai a quantidade informada do estoque atual do produto. - Balanço (
"balance"): Substitui o estoque atual do produto pela quantidade informada.
> Importante: Para alterações do tipo balance, o estoque reservado será subtraído do valor informado, garantindo a consistência das reservas.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {userToken} | Token de autenticação |
Parâmetros do Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
productId | integer | ✅ | Id do produto que o estoque deve ser atualizado |
storageId | integer | ✅ | Identificador numérico do armazém onde a atualização será realizada. Certifique-se de informar um armazém já cadastrado. |
stock | integer | ✅ | Quantidade de estoque a ser ajustada para o produto no armazém especificado |
type | integer | ✅ | Tipo do estoque ("entry", "out", "balance") |
📤 Exemplo de requisição
1curl --request PUT \2 --url https://sua-loja-uappi.com.br/api/v3/products/stocks \3 --Authentication: Bearer {userToken} \4 --data '{5 "stocks": [6 {7 "productId": 50,8 "storageId": 1,9 "stock": 7,10 "type": "out"11 },12 {13 "productId": 52,14 "storageId": 1,15 "stock": 19,16 "type": "balance"17 }18 ]19 }'✅ Resposta de Sucesso
1{2 "status": true,3 "data": [4 {5 "productId": 50,6 "storageId": 1,7 "stock": 7,8 "reservedStock": 20,9 "type": "out",10 "error": "UAPPI_STORE_STOCK_INSUFFICIENT_AVAILABLE_STOCK"11 },12 {13 "productId": 52,14 "storageId": 1,15 "stock": 17,16 "reservedStock": 2,17 "type": "balance",18 "error": ""19 }20 ]21}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
A atualização de estoque pode resultar nos seguintes erros:
| Código Interno | Código HTTP | Descrição |
|---|---|---|
| UAPPI_STORE_PRODUCT_NOT_FOUND | 404 | O produto solicitado não foi encontrado. |
| UAPPI_STORE_STORAGE_NOT_FOUND | 404 | O armazém solicitado não foi encontrado. |
| UAPPI_STORE_SALE_WITHOUT_STOCK_ACTIVE | 400 | A flag de venda sem estoque para esse produto está ativa. |
| UAPPI_STORE_STOCK_UPDATE_PRODUCT_WITH_VARIATION_STOCK | 400 | O produto possui variações, portanto o estoque não pode ser alterado diretamente. |
| UAPPI_STORE_STOCK_BELLOW_MINIMUM | 400 | O estoque informado é menor que o mínimo permitido. |