Get a list of items

GET/api/crm/v2/itemsv2

operationId: items.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

category_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

branch_idinteger

Example: 1

automation_have_importboolean

Example: true

sizesobject

image_mobileobject

widthinteger

Example: 750

heightinteger

Example: 300

image_desktopobject

widthinteger

Example: 1500

heightinteger

Example: 1500

listarray of object

idintegerrequired

Example: 18085142

nameobject (TranslationField) required

Translatable catalog field; has the same structure in both response and request. When creating, each network language not present in translations remains empty and is queued for AI translation. When updating, only languages from translations are saved: a language not present in the object retains its previous value if the original has not changed; an empty value clears the translation and queues it for AI translation. Changing the original clears translations that were not updated—these no longer match the original; a translation submitted with a different value is saved as a manual edit. This clearing occurs only while automatic translation is enabled for the network. Values in unpublished languages are rejected; values in languages outside the network's language set are ignored.

defaultstring

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

Example: ru

translationsobjectrequired

Value by language code; if no translation — no key

Dictionary values

string

separate_export_enabledbooleanrequired

Example: true

publishedbooleanrequired

Example: true

discount_enabledbooleanrequired

Example: true

recommend_enabledbooleanrequired

Example: false

stock_balance_enabledbooleanrequired

Example: false

free_delivery_enabledbooleanrequired

Example: true

minimum_sum_enabledbooleanrequired

Example: true

popular_enabledbooleanrequired

Example: true

bonuses_accrual_enabledbooleanrequired

Example: true

bonuses_withdraw_enabledbooleanrequired

Example: true

image_desktopstringrequired

Example: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/medium/ec5b325fc4aa11721ecae38ae841f90b.jpg?v1745505855

image_mobilestringrequired

Example: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/mobile/e12a68ed472cefd7ba68daaf6299ec2f.jpg?v1745505855

sortintegerrequired

Example: 1

date_availablestring (DataTimeFormatSQL)

Example: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Example: 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_idintegerrequired

Example: 3389048

compositionobject (TranslationField)

defaultstring

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

Example: ru

translationsobjectrequired

Value by language code; if no translation — no key

Dictionary values

string

modifiers_multiplier_enabledbooleanrequired

Example: true

hide_cost_if_zero_enabledbooleanrequired

Example: true

only_informing_enabledbooleanrequired

Example: true

excise_enabledboolean

Example: true

typestring

Values:bouquetproductcombodishdrinkgift

Example: product

parametersarray of objectrequired

idintegerrequired

Example: 1

descriptionstring

Example: tasty, with onion

measure_idinteger

Example: 1

measure_indexintegerrequired

Example: 1

old_costnumberrequired

Example: 100

costnumberrequired

Example: 90

bonusesnumberrequired

Example: 90

vendor_codestring

Example: d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73144e5

sortintegerrequired

Example: 1

modifiers_groups_idsarray of integer

proteinsinteger

Example: 10

fatsinteger

Example: 10

carbohydratesinteger

Example: 10

caloriesinteger

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