Kateqoriyaların siyahısını əldə et

GET/api/crm/v2/categoriesv2

operationId: categories.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

branch_idinteger

Nümunə: 1

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

listarray of object

idintegermütləq

Nümunə: 1

nameobject (TranslationField) mütləq

Kataloq üçün tərcümə olunan sahə; cavabda və sorğuda eyni struktura malikdir.
Yaradılarkən translations daxilində olmayan şəbəkənin hər dili boş qalır və AI-tərcümə növbəsinə əlavə olunur.
Dəyişiklik zamanı yalnız translations daxilində olan dillər yazılır: obyektə daxil olmayan dil əvvəlki dəyərini saxlayır, əgər orijinal dəyişməyibsə; boş dəyər tərcüməni silir və onu AI-tərcümə növbəsinə əlavə edir.
Orijinalın dəyişməsi, dəyişməyən tərcümələri silir — onlar artıq uyğun deyil; fərqli dəyərlə göndərilən tərcümə əl düzəlişi kimi saxlanılır. Bu təmizləmə yalnız şəbəkədə avtomatik tərcümə aktiv olduqda baş verir.
Yayımlanmamış dildə olan dəyər rədd edilir; şəbəkənin dil dəstindən kənar dildə olan dəyər isə nəzərə alınmır.

defaultstring

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

Nümunə: ru

translationsobjectmütləq

Dil koduna görə dəyər; tərcümə yoxdursa — açar yoxdur

Lüğət dəyərləri

string

parent_idinteger

Nümunə: 1

discount_enabledboolean

Nümunə: true

minimum_sum_enabledboolean

Nümunə: true

free_delivery_enabledboolean

Nümunə: true

sortintegermütləq

Nümunə: 1

publishedboolean

Nümunə: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Nümunə: 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' => 'az', '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": "az", "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": "az", "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" ] } ] } }