Получить список товаров

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.pro/api/crm/v2/items', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/items", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "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 } ] } ] } }