Gauti kategorijų sąrašą

GET/api/crm/v2/categoriesv2

operationId: categories.default

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 1

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

listarray of object

idintegerprivalomas

Pavyzdys: 1

nameobject (TranslationField) privalomas

Verčiamas katalogo laukas; struktūra vienoda tiek atsakyme, tiek užklausoje.
Kuriant kiekviena tinklo kalba, kurios nėra translations, lieka tuščia ir įtraukiama į AI vertimo eilę.
Keičiant įrašomi tik translations esantys kalbos: kalba, kurios nėra objekte, išlaiko ankstesnę reikšmę, jei originalas nepasikeitė; tuščia reikšmė išvalo vertimą ir įtraukia jį į AI vertimo eilę.
Originalo pakeitimas išvalo vertimus, kurie nebuvo pakeisti — jie nebeatitinka originalo; vertimas, perduotas su kita reikšme, išsaugomas kaip rankinis taisymas. Toks išvalymas vyksta tik tada, kai tinkle įjungtas automatinis vertimas.
Reikšmė nepublikuota kalba atmetama; reikšmė kalba, kuri nėra tinklo kalbų rinkinyje, ignoruojama.

defaultstring

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

Pavyzdys: ru

translationsobjectprivalomas

Vertė pagal kalbos kodą; nėra vertimo — nėra rakto

Žodyno reikšmės

string

parent_idinteger

Pavyzdys: 1

discount_enabledboolean

Pavyzdys: true

minimum_sum_enabledboolean

Pavyzdys: true

free_delivery_enabledboolean

Pavyzdys: true

sortintegerprivalomas

Pavyzdys: 1

publishedboolean

Pavyzdys: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

Pavyzdys: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

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