Obter saldo de estoque dos itens

GET/api/crm/v2/items_stock_balancev2

operationId: itemsStockBalance.default

Retorna os saldos de estoque dos itens da filial. Apenas os parâmetros dos itens com stock_balance_enabled ativado são incluídos na lista.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

category_namestring

Exemplo: Pizza

item_namestring

Exemplo: Pizza

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

category_nameobject (FilterInput)

valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

item_nameobject (FilterInput)

valuestring

Exemplo: example

typestringobrigatório

Exemplo: integer or string

placeholderstring

Exemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 94060753

stock_balanceintegerobrigatório

Exemplo: 1

stop_list_enabledbooleanobrigatório

Exemplo: true

namestringobrigatório

Exemplo: Mussels in cream sauce - 501 g

category_namestringobrigatório

Exemplo: Seafood

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/items_stock_balance', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'pt', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/items_stock_balance", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/items_stock_balance", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "category_name": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" }, "item_name": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" } }, "list": [ { "id": 94060753, "stock_balance": 1, "stop_list_enabled": true, "name": "Mussels in cream sauce - 501 g", "category_name": "Seafood" } ] } }