API

Obtenir la liste d'arrêt

GET/api/crm/v2/items_stop_listv2
operationId: itemsStopList.default

Retourne la liste d'arrêt. La liste inclut uniquement les paramètres des articles avec stop_list_enabled activé.

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

category_namestring

Exemple: Pizza

item_namestring

Exemple: Pizza

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
branch_idinteger

Exemple: 1

filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

category_nameobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

item_nameobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of object
idintegerobligatoire

Exemple: 94060229

stock_balanceintegerobligatoire

Exemple: 1

stop_list_enabledbooleanobligatoire

Exemple: true

namestringobligatoire

Exemple: Mussels in cream sauce - 501 g

category_namestringobligatoire

Exemple: Seafood