Отримати список товарів

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