Kategori listesini al

GET/api/crm/v2/categoriesv2

operationId: categories.default

Yetkilendirme

api-token + language + role

Sorgu parametreleri

branch_idinteger

Örnek: 1

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

listarray of object

idintegerzorunlu

Örnek: 1

nameobject (TranslationField) zorunlu

Çevrilebilir katalog alanı; yanıttaki ve istekteki yapısı aynıdır.
Oluşturma sırasında, translations içinde olmayan ağın her dili boş kalır ve AI çeviri kuyruğuna alınır.
Güncellemede yalnızca translations içindeki diller kaydedilir: nesnede olmayan bir dil, orijinali değişmediyse önceki değerini korur; boş değer, çeviriyi temizler ve AI çeviri kuyruğuna alır.
Orijinalin değiştirilmesi, değişmeden gelen çevirileri temizler — artık orijinale karşılık gelmezler; farklı bir değerle iletilen çeviri manuel düzeltme olarak kaydedilir. Bu temizlik, yalnızca ağda otomatik çeviri etkin olduğu sürece gerçekleşir.
Yayınlanmamış bir dildeki değer reddedilir; ağın dil seti dışında bir dildeki değer yok sayılır.

defaultstring

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

Örnek: ru

translationsobjectzorunlu

Dil koduna göre değer; çeviri yoksa anahtar yok

Sözlük değerleri

string

parent_idinteger

Örnek: 1

discount_enabledboolean

Örnek: true

minimum_sum_enabledboolean

Örnek: true

free_delivery_enabledboolean

Örnek: true

sortintegerzorunlu

Örnek: 1

publishedboolean

Örnek: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Örnek: 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' => 'tr', '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": "tr", "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": "tr", "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" ] } ] } }