Iegūt kategoriju sarakstu

GET/api/crm/v2/categoriesv2

operationId: categories.default

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

listarray of object

idintegerobligāts

Piemērs: 1

nameobject (TranslationField) obligāts

Tulkotais lauks katalogā; vienādas struktūras atbildē un pieprasījumā.
Izveidojot katra tīkla valoda, kuras nav translations, paliek tukša un tiek ievietota rindā AI tulkojumam.
Mainot tiek saglabātas tikai tās valodas, kas ir translations: valoda, kuras nav objektā, saglabā iepriekšējo vērtību, ja oriģināls nav mainīts; tukša vērtība notīra tulkojumu un ievieto to rindā AI tulkojumam.
Oriģināla izmaiņa notīra tos tulkojumus, kas nav mainīti, — tie vairs neatbilst oriģinālam; tulkojums, kas nodots ar citu vērtību, tiek saglabāts kā manuāla korekcija. Šāda tīrīšana notiek tikai tad, ja tīklā ir ieslēgta automātiskā tulkošana.
Vērtība nepublicētā valodā tiek noraidīta; vērtība valodā ārpus tīkla valodu kopas tiek ignorēta.

defaultstring

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

Piemērs: ru

translationsobjectobligāts

Vērtība pēc valodas koda; nav tulkojuma — nav atslēgas

Vārdnīcas vērtības

string

parent_idinteger

Piemērs: 1

discount_enabledboolean

Piemērs: true

minimum_sum_enabledboolean

Piemērs: true

free_delivery_enabledboolean

Piemērs: true

sortintegerobligāts

Piemērs: 1

publishedboolean

Piemērs: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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" ] } ] } }