Abrufen von Nachschlagewerken für Filialen

GET/api/crm/v2/branches.fieldsv2

operationId: branches.fields

Gibt Nachschlagewerke für das Filialformular zurück. Die Parameter chain_id und city_id sind erforderlich.

Autorisierung

api-token + language + role

Abfrageparameter

chain_idintegererforderlich

Beispiel: 7158

city_idintegererforderlich

Beispiel: 7158

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

Für die Erstellung — city_id (Parameter city_id erforderlich), für die Änderung — city (ohne Parameter city_id)

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

round_costs_modeobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

service_nameobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "round_costs_mode": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "service_name": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }