Obtener catálogos para promociones

GET/api/crm/v2/special_offers_list.fieldsv2

operationId: specialOffersList.fields

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Sucursal en la que se realiza la solicitud. Un socio con varias sucursales debe proporcionarla, de lo contrario la solicitud fallará. Para un socio con una sola sucursal, el servidor la asigna automáticamente.

Ejemplo: 8778

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

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

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

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

platformobject (FilterEnum)

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

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

typeobject (FilterEnum)

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

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

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

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

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

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

delivery_methodobject (FilterEnum)

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

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/special_offers_list.fields', [ '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/special_offers_list.fields", { 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/special_offers_list.fields", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "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" } } }