Obter diretórios para o formulário de pedidos

GET/api/crm/v2/orders.fieldsv2

operationId: orders.fields

Retorna diretórios para o formulário de pedidos. order_status contém as transições disponíveis a partir do status atual.

Autorização

api-token + language + role

Parâmetros de consulta

order_statusstring (OrderStatus) obrigatório

Status do pedido: em trânsito, concluído, em montagem, na cozinha, não processado, pronto para envio, aguardando envio para a cozinha, aguardando refação, cancelado, confirmado, preparado

Valores:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemplo: confirmed

branch_idintegerobrigatório

Exemplo: 8779

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

order_statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

courier_service_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

pickup_address_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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" } } }