Obtener catálogos para el formulario de pedidos

GET/api/crm/v2/orders.fieldsv2

operationId: orders.fields

Devuelve los catálogos para el formulario de pedidos. order_status contiene las transiciones disponibles desde el estado actual.

Autorización

api-token + language + role

Parámetros de consulta

order_statusstring (OrderStatus) obligatorio

Estado del pedido: en camino, completado, en preparación, en cocina, no procesado, listo para enviar, esperando envío a cocina, esperando rehacer, cancelado, confirmado, preparado

Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Ejemplo: confirmed

branch_idintegerobligatorio

Ejemplo: 8779

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

order_statusobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

courier_service_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

pickup_address_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/orders.fields?order_status=confirmed&branch_id=8779', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'es', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/orders.fields?order_status=confirmed&branch_id=8779", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/orders.fields?order_status=confirmed&branch_id=8779", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "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" } } }