Ottenere i dizionari per il modulo ordini

GET/api/crm/v2/orders.fieldsv2

operationId: orders.fields

Restituisce i dizionari per il modulo ordini. order_status contiene le transizioni disponibili dallo stato attuale.

Autorizzazione

api-token + language + role

Parametri della richiesta

order_statusstring (OrderStatus) obbligatorio

Stato dell'ordine: in consegna, completato, in preparazione, in cucina, non elaborato, pronto per la spedizione, in attesa di invio in cucina, in attesa di rifacimento, annullato, confermato, preparato

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Esempio: confirmed

branch_idintegerobbligatorio

Esempio: 8779

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

order_statusobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

courier_service_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: value_required

pickup_address_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Valori:force_shownvalue_required

Esempio: 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' => 'it', '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": "it", "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": "it", "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" } } }