კატეგორიების სიის მიღება

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