Ստանալ կատեգորիաների ցանկը

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' => 'hy', '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": "hy", "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": "hy", "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" ] } ] } }