Get a list of categories

GET/api/crm/v2/categoriesv2

operationId: categories.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

listarray of object

idintegerrequired

Example: 1

nameobject (TranslationField) required

Translatable catalog field; has the same structure in both response and request. When creating, each network language not present in translations remains empty and is queued for AI translation. When updating, only languages from translations are saved: a language not present in the object retains its previous value if the original has not changed; an empty value clears the translation and queues it for AI translation. Changing the original clears translations that were not updated—these no longer match the original; a translation submitted with a different value is saved as a manual edit. This clearing occurs only while automatic translation is enabled for the network. Values in unpublished languages are rejected; values in languages outside the network's language set are ignored.

defaultstring

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

Example: ru

translationsobjectrequired

Value by language code; if no translation — no key

Dictionary values

string

parent_idinteger

Example: 1

discount_enabledboolean

Example: true

minimum_sum_enabledboolean

Example: true

free_delivery_enabledboolean

Example: true

sortintegerrequired

Example: 1

publishedboolean

Example: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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