Отримати список категорій

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.pro/api/crm/v2/categories', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'uk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/categories", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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" ] } ] } }