Abrufen von Nachschlagewerken für Sonderangebote

GET/api/crm/v2/special_offers_list.fieldsv2

operationId: specialOffersList.fields

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Die Filiale, in der die Anfrage ausgeführt wird. Ein Partner mit mehreren Filialen muss diesen Parameter angeben, andernfalls wird die Anfrage mit einem Fehler abgelehnt. Bei einem Partner mit nur einer Filiale wird dieser Wert vom Server automatisch gesetzt.

Beispiel: 8778

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

operating_modeobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string

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

hide_for_districts_idsobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

hide_for_pickups_idsobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

platformobject (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

typeobject (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

actions_itemsobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

conditions_itemsobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

actions_categoriesobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

conditions_categoriesobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Werte:force_shownvalue_required

Beispiel: value_required

delivery_methodobject (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/special_offers_list.fields', [ '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/special_offers_list.fields", { 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/special_offers_list.fields", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "operating_mode": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "hide_for_districts_ids": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "hide_for_pickups_ids": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "platform": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "type": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "actions_items": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "conditions_items": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "actions_categories": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "conditions_categories": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "delivery_method": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }