API legada/Guia rápido/Preço e estoque do produto

Estoque do produto

Lê o saldo de estoque de um produto com um token de app e o escopo read_inventory, com as regras do modelo de estoque.

O estoque de um produto é a quantidade disponível para venda. Esta página mostra a rota de leitura para apps de terceiros com token de app, usada por conectores que só precisam consultar o saldo. Antes de usá-la, leia o modelo de estoque em Preço e estoque do produto.

Consultar o saldo com token de app

GET/api/admin/products/{id}/inventoryAutenticada

Token de app: ler o estoque de um produto

Rota para apps de terceiros (conectores de ERP, marketplaces) que consultam o saldo sem usar o login de uma pessoa. O acesso é por token de app (vat_live_... ou vat_test_...) com o escopo read_inventory; um JWT de usuário não funciona aqui. Como criar o app e o token: Produtos por token de app.

Cabeçalhos

Authorizationstringobrigatório

Bearer vat_live_... (o token do app).

Parâmetros de caminho

iduuidobrigatório

Id do produto. Um número 0 ou negativo é recusado com 400 antes de chegar ao produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/admin/products/$PRODUCT_ID/inventory" \
  -H "Authorization: Bearer $APP_TOKEN"

Resposta

200Saldo do produto

json

{ "product_id": "c3f92551-9dda-4fc7-b518-353d1c4e4035", "quantity": 22 }

Campos da resposta

product_idstring

O id enviado no caminho, ecoado.

quantityinteger

Saldo em unidades inteiras. Se o saldo tiver fração (produto vendido por peso), a fração é descartada.

Erros

Status	Quando	Corpo
400	O id do caminho é `0` ou um inteiro negativo.	`{"error":"invalid id parameter"}`
401	Sem token de app, ou um JWT de usuário no lugar dele.	`{"error":"app_token_required"}`
401	Token de app inválido ou expirado.	`{"error":"invalid or expired app access token"}`
403	O token não tem o escopo `read_inventory`.	`{"error":"missing_scope","required":"read_inventory"}`
500	O id não é um UUID válido.	`{"error":"failed to fetch inventory","detail":"..."}`

Veja também

Preço e estoque do produto: o modelo de estoque explicado do zero.
Produtos por token de app
Atualizar produto: o campo amount altera o estoque.