Тауарлар тізімін алу

GET/api/crm/v2/itemsv2

operationId: items.default

Авторизация

api-token + language + role

Сұраныс параметрлері

branch_idinteger

Мысал: 1

category_idinteger

Мысал: 1

Жауаптар

object

statusstringміндетті

Мәндер:successerror

Мысал: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object

valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

branch_idinteger

Мысал: 1

automation_have_importboolean

Мысал: true

sizesobject

image_mobileobject

widthinteger

Мысал: 750

heightinteger

Мысал: 300

image_desktopobject

widthinteger

Мысал: 1500

heightinteger

Мысал: 1500

listarray of object

idintegerміндетті

Мысал: 18085142

nameobject (TranslationField) міндетті

Аударылатын каталог өрісі; жауапта және сұраныста құрылымы бірдей. Жасау кезінде translations ішінде жоқ желі тілдері бос қалады және AI-аудармаға кезекке қойылады. Өзгерту кезінде тек translations ішіндегі тілдер жазылады: объектіде жоқ тіл бұрынғы мәнін сақтайды, егер түпнұсқа өзгермесе; бос мән аударманы тазартады және оны AI-аудармаға кезекке қояды. Түпнұсқаны өзгерту өзгеріссіз келген аудармаларды тазартады — олар енді сәйкес емес; басқа мәнмен берілген аударма қолмен түзету ретінде сақталады. Мұндай тазарту тек желіде автоматты аударма қосулы кезде орындалады. Жарияланбаған тілдегі мән қабылданбайды; желі тілдері жиынтығына кірмейтін тілдегі мән еленбейді.

defaultstring

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

Мысал: ru

translationsobjectміндетті

Тіл коды бойынша мәні; аудармасы жоқ — кілт жоқ

Сөздік мәндері

string

separate_export_enabledbooleanміндетті

Мысал: true

publishedbooleanміндетті

Мысал: true

discount_enabledbooleanміндетті

Мысал: true

recommend_enabledbooleanміндетті

Мысал: false

stock_balance_enabledbooleanміндетті

Мысал: false

free_delivery_enabledbooleanміндетті

Мысал: true

minimum_sum_enabledbooleanміндетті

Мысал: true

popular_enabledbooleanміндетті

Мысал: true

bonuses_accrual_enabledbooleanміндетті

Мысал: true

bonuses_withdraw_enabledbooleanміндетті

Мысал: true

image_desktopstringміндетті

Мысал: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/medium/ec5b325fc4aa11721ecae38ae841f90b.jpg?v1745505855

image_mobilestringміндетті

Мысал: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/mobile/e12a68ed472cefd7ba68daaf6299ec2f.jpg?v1745505855

sortintegerміндетті

Мысал: 1

date_availablestring (DataTimeFormatSQL)

Мысал: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Мысал: 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_idintegerміндетті

Мысал: 3389048

compositionobject (TranslationField)

defaultstring

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

Мысал: ru

translationsobjectміндетті

Тіл коды бойынша мәні; аудармасы жоқ — кілт жоқ

Сөздік мәндері

string

modifiers_multiplier_enabledbooleanміндетті

Мысал: true

hide_cost_if_zero_enabledbooleanміндетті

Мысал: true

only_informing_enabledbooleanміндетті

Мысал: true

excise_enabledboolean

Мысал: true

typestring

Мәндер:bouquetproductcombodishdrinkgift

Мысал: product

parametersarray of objectміндетті

idintegerміндетті

Мысал: 1

descriptionstring

Мысал: tasty, with onion

measure_idinteger

Мысал: 1

measure_indexintegerміндетті

Мысал: 1

old_costnumberміндетті

Мысал: 100

costnumberміндетті

Мысал: 90

bonusesnumberміндетті

Мысал: 90

vendor_codestring

Мысал: d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73144e5

sortintegerміндетті

Мысал: 1

modifiers_groups_idsarray of integer

proteinsinteger

Мысал: 10

fatsinteger

Мысал: 10

carbohydratesinteger

Мысал: 10

caloriesinteger

Мысал: 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' => 'kk', '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": "kk", "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": "kk", "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 } ] } ] } }