Получить список категорий

GET/api/crm/v2/categoriesv2

operationId: categories.default

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 1

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

listarray of object

idintegerобязательный

Пример: 1

nameobject (TranslationField) обязательный

Переводимое поле каталога; одинаковой структуры в ответе и в запросе. При создании каждый язык сети, которого нет в translations, остаётся пустым и ставится в очередь на AI-перевод. При изменении записываются только языки из translations: язык, которого нет в объекте, сохраняет прежнее значение, если оригинал не изменился; пустое значение очищает перевод и ставит его в очередь на AI-перевод. Изменение оригинала очищает переводы, пришедшие без изменений, — они ему больше не соответствуют; перевод, переданный с другим значением, сохраняется как ручная правка. Такая очистка происходит, только пока у сети включён автоматический перевод. Значение на неопубликованном языке отклоняется; значение на языке вне набора языков сети игнорируется.

defaultstring

Код исходного языка сети; в запросе должен совпадать с настройкой сети

Пример: ru

translationsobjectобязательный

Значение по коду языка; нет перевода — нет ключа

Значения словаря

string

parent_idinteger

Пример: 1

discount_enabledboolean

Пример: true

minimum_sum_enabledboolean

Пример: true

free_delivery_enabledboolean

Пример: true

sortintegerобязательный

Пример: 1

publishedboolean

Пример: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

Пример: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Пример: 2024-05-02 08:31:16

days_of_weekarray of integer

time_periodsarray of string

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/categories", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/categories", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "list": [ { "id": 1, "name": { "default": "ru", "translations": { "ru": "Пицца", "en": "Pizza" } }, "parent_id": 1, "discount_enabled": true, "minimum_sum_enabled": true, "free_delivery_enabled": true, "sort": 1, "published": true, "hide_for_districts_ids": [ 1 ], "hide_for_pickups_ids": [ 1 ], "date_available": "2024-05-02 08:31:16", "date_expiration": "2024-05-02 08:31:16", "days_of_week": [ 1 ], "time_periods": [ "11:24 - 12:34" ] } ] } }