Məhsullar siyahısını əldə et

GET/api/crm/v2/itemsv2

operationId: items.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

branch_idinteger

Nümunə: 1

category_idinteger

Nümunə: 1

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

branch_idinteger

Nümunə: 1

automation_have_importboolean

Nümunə: true

sizesobject

image_mobileobject

widthinteger

Nümunə: 750

heightinteger

Nümunə: 300

image_desktopobject

widthinteger

Nümunə: 1500

heightinteger

Nümunə: 1500

listarray of object

idintegermütləq

Nümunə: 18085142

nameobject (TranslationField) mütləq

Kataloq üçün tərcümə olunan sahə; cavabda və sorğuda eyni struktura malikdir.
Yaradılarkən translations daxilində olmayan şəbəkənin hər dili boş qalır və AI-tərcümə növbəsinə əlavə olunur.
Dəyişiklik zamanı yalnız translations daxilində olan dillər yazılır: obyektə daxil olmayan dil əvvəlki dəyərini saxlayır, əgər orijinal dəyişməyibsə; boş dəyər tərcüməni silir və onu AI-tərcümə növbəsinə əlavə edir.
Orijinalın dəyişməsi, dəyişməyən tərcümələri silir — onlar artıq uyğun deyil; fərqli dəyərlə göndərilən tərcümə əl düzəlişi kimi saxlanılır. Bu təmizləmə yalnız şəbəkədə avtomatik tərcümə aktiv olduqda baş verir.
Yayımlanmamış dildə olan dəyər rədd edilir; şəbəkənin dil dəstindən kənar dildə olan dəyər isə nəzərə alınmır.

defaultstring

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

Nümunə: ru

translationsobjectmütləq

Dil koduna görə dəyər; tərcümə yoxdursa — açar yoxdur

Lüğət dəyərləri

string

separate_export_enabledbooleanmütləq

Nümunə: true

publishedbooleanmütləq

Nümunə: true

discount_enabledbooleanmütləq

Nümunə: true

recommend_enabledbooleanmütləq

Nümunə: false

stock_balance_enabledbooleanmütləq

Nümunə: false

free_delivery_enabledbooleanmütləq

Nümunə: true

minimum_sum_enabledbooleanmütləq

Nümunə: true

popular_enabledbooleanmütləq

Nümunə: true

bonuses_accrual_enabledbooleanmütləq

Nümunə: true

bonuses_withdraw_enabledbooleanmütləq

Nümunə: true

image_desktopstringmütləq

Nümunə: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/medium/ec5b325fc4aa11721ecae38ae841f90b.jpg?v1745505855

image_mobilestringmütləq

Nümunə: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/mobile/e12a68ed472cefd7ba68daaf6299ec2f.jpg?v1745505855

sortintegermütləq

Nümunə: 1

date_availablestring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

days_of_weekarray of integer

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

labels_idsarray of integer

template_modifiers_groups_idsarray of integer

category_idintegermütləq

Nümunə: 3389048

compositionobject (TranslationField)

defaultstring

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

Nümunə: ru

translationsobjectmütləq

Dil koduna görə dəyər; tərcümə yoxdursa — açar yoxdur

Lüğət dəyərləri

string

modifiers_multiplier_enabledbooleanmütləq

Nümunə: true

hide_cost_if_zero_enabledbooleanmütləq

Nümunə: true

only_informing_enabledbooleanmütləq

Nümunə: true

excise_enabledboolean

Nümunə: true

typestring

Dəyərlər:bouquetproductcombodishdrinkgift

Nümunə: product

parametersarray of objectmütləq

idintegermütləq

Nümunə: 1

descriptionstring

Nümunə: tasty, with onion

measure_idinteger

Nümunə: 1

measure_indexintegermütləq

Nümunə: 1

old_costnumbermütləq

Nümunə: 100

costnumbermütləq

Nümunə: 90

bonusesnumbermütləq

Nümunə: 90

vendor_codestring

Nümunə: d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73144e5

sortintegermütləq

Nümunə: 1

modifiers_groups_idsarray of integer

proteinsinteger

Nümunə: 10

fatsinteger

Nümunə: 10

carbohydratesinteger

Nümunə: 10

caloriesinteger

Nümunə: 10

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/items', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'az', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/items", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "az", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/items", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "az", "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" } }, "branch_id": 1, "automation_have_import": true, "sizes": { "image_mobile": { "width": 750, "height": 300 }, "image_desktop": { "width": 1500, "height": 1500 } }, "list": [ { "id": 18085142, "name": { "default": "ru", "translations": { "ru": "Пицца", "en": "Pizza" } }, "separate_export_enabled": true, "published": true, "discount_enabled": true, "recommend_enabled": false, "stock_balance_enabled": false, "free_delivery_enabled": true, "minimum_sum_enabled": true, "popular_enabled": true, "bonuses_accrual_enabled": true, "bonuses_withdraw_enabled": true, "image_desktop": "https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/medium/ec5b325fc4aa11721ecae38ae841f90b.jpg?v1745505855", "image_mobile": "https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/mobile/e12a68ed472cefd7ba68daaf6299ec2f.jpg?v1745505855", "sort": 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" ], "hide_for_districts_ids": [ 55311 ], "hide_for_pickups_ids": [ 4926 ], "labels_ids": [ 7411 ], "template_modifiers_groups_ids": [ 17589435 ], "category_id": 3389048, "composition": { "default": "ru", "translations": { "ru": "Пицца", "en": "Pizza" } }, "modifiers_multiplier_enabled": true, "hide_cost_if_zero_enabled": true, "only_informing_enabled": true, "excise_enabled": true, "type": "product", "parameters": [ { "id": 1, "description": "tasty, with onion", "measure_id": 1, "measure_index": 1, "old_cost": 100, "cost": 90, "bonuses": 90, "vendor_code": "d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73144e5", "sort": 1, "modifiers_groups_ids": [], "proteins": 10, "fats": 10, "carbohydrates": 10, "calories": 10 } ] } ] } }