Obtener la lista de artículos fuera de stock

GET/api/crm/v2/items_stop_listv2

operationId: itemsStopList.default

Devuelve la lista de exclusión. La lista incluye solo los parámetros de los productos con stop_list_enabled activado.

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

category_namestring

Ejemplo: Pizza

item_namestring

Ejemplo: Pizza

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

branch_idinteger

Ejemplo: 1

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

category_nameobject (FilterInput)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

item_nameobject (FilterInput)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 94060229

stock_balanceintegerobligatorio

Ejemplo: 1

stop_list_enabledbooleanobligatorio

Ejemplo: true

namestringobligatorio

Ejemplo: Mussels in cream sauce - 501 g

category_namestringobligatorio

Ejemplo: Seafood

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

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

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

{ "status": "success", "data": { "branch_id": 1, "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": 94060229, "stock_balance": 1, "stop_list_enabled": true, "name": "Mussels in cream sauce - 501 g", "category_name": "Seafood" } ] } }