Abrufen von Nachschlagewerten für das Bestellformular

GET/api/crm/v2/orders.fieldsv2

operationId: orders.fields

Gibt Nachschlagewerke für das Bestellformular zurück. order_status enthält die aus dem aktuellen Status verfügbaren Übergänge.

Autorisierung

api-token + language + role

Abfrageparameter

order_statusstring (OrderStatus) erforderlich

Bestellstatus: unterwegs, abgeschlossen, Zusammenstellung, in der Küche, nicht bearbeitet, versandbereit, wartet auf Versand in die Küche, wartet auf Nachbesserung, storniert, bestätigt, zubereitet

Werte:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Beispiel: confirmed

branch_idintegererforderlich

Beispiel: 8779

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

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

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

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

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/orders.fields?order_status=confirmed&branch_id=8779', [ '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/orders.fields?order_status=confirmed&branch_id=8779", { 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/orders.fields?order_status=confirmed&branch_id=8779", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "role": "partner", }, ) data = response.json()

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