Obtenir les référentiels pour le formulaire de liste d'arrêt

GET/api/crm/v2/items_stop_list.fieldsv2

operationId: itemsStopList.fields

Renvoie les référentiels pour le formulaire. Les paramètres sont indiqués sous la forme catégorie → nom du paramètre.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 8785

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

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

curl -X GET 'https://foodsoul.pro/api/crm/v2/items_stop_list.fields?branch_id=8785' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/items_stop_list.fields?branch_id=8785', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'fr',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

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

import requests

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

Réponse 200

{
  "status": "success",
  "data": {
    "id": {
      "value": 8920,
      "type": "select",
      "option": [
        {
          "value": 8920,
          "name": "Green Basket | Kaliningrad"
        }
      ],
      "mode": "value_required"
    }
  }
}

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.