Obține lista categoriilor

GET/api/crm/v2/categoriesv2

operationId: categories.default

Autorizare

api-token + language + role

Parametri de interogare

branch_idinteger

Exemplu: 1

Răspunsuri

object

statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

listarray of object

idintegerobligatoriu

Exemplu: 1

nameobject (TranslationField) obligatoriu

Câmp de catalog traductibil; structură identică în răspuns și în cerere.
La creare, fiecare limbă a rețelei care nu este prezentă în translations rămâne goală și este pusă în coadă pentru traducere AI.
La modificare, sunt salvate doar limbile din translations: o limbă care nu este în obiect își păstrează valoarea anterioară dacă originalul nu s-a schimbat; o valoare goală șterge traducerea și o pune în coadă pentru traducere AI.
Modificarea originalului șterge traducerile care au rămas neschimbate — acestea nu mai corespund originalului; traducerea transmisă cu altă valoare este salvată ca modificare manuală. Această ștergere are loc doar cât timp traducerea automată este activată pentru rețea.
Valoarea într-o limbă nepublicată este respinsă; valoarea într-o limbă care nu face parte din setul de limbi al rețelei este ignorată.

defaultstring

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

Exemplu: ru

translationsobjectobligatoriu

Valoare după codul limbii; dacă nu există traducere — nu există cheie

Valorile dicționarului

string

parent_idinteger

Exemplu: 1

discount_enabledboolean

Exemplu: true

minimum_sum_enabledboolean

Exemplu: true

free_delivery_enabledboolean

Exemplu: true

sortintegerobligatoriu

Exemplu: 1

publishedboolean

Exemplu: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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