Získat seznam položek

GET/api/crm/v2/itemsv2

operationId: items.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 1

category_idinteger

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

branch_idinteger

Příklad: 1

automation_have_importboolean

Příklad: true

sizesobject

image_mobileobject

widthinteger

Příklad: 750

heightinteger

Příklad: 300

image_desktopobject

widthinteger

Příklad: 1500

heightinteger

Příklad: 1500

listarray of object

idintegerpovinné

Příklad: 18085142

nameobject (TranslationField) povinné

Překládané pole katalogu; stejná struktura v odpovědi i v požadavku.
Při vytváření zůstane každý jazyk sítě, který není v translations, prázdný a zařadí se do fronty na AI překlad.
Při úpravě se zapisují pouze jazyky z translations: jazyk, který není v objektu, si ponechá původní hodnotu, pokud se originál nezměnil; prázdná hodnota vymaže překlad a zařadí jej do fronty na AI překlad.
Změna originálu vymaže překlady, které přišly beze změny — již neodpovídají originálu; překlad, který je předán s jinou hodnotou, se uloží jako ruční úprava. Takové vymazání probíhá pouze tehdy, pokud má síť zapnutý automatický překlad.
Hodnota v nepublikovaném jazyce je odmítnuta; hodnota v jazyce mimo sadu jazyků sítě je ignorována.

defaultstring

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

Příklad: ru

translationsobjectpovinné

Hodnota podle kódu jazyka; pokud překlad chybí — klíč není

Hodnoty slovníku

string

separate_export_enabledbooleanpovinné

Příklad: true

publishedbooleanpovinné

Příklad: true

discount_enabledbooleanpovinné

Příklad: true

recommend_enabledbooleanpovinné

Příklad: false

stock_balance_enabledbooleanpovinné

Příklad: false

free_delivery_enabledbooleanpovinné

Příklad: true

minimum_sum_enabledbooleanpovinné

Příklad: true

popular_enabledbooleanpovinné

Příklad: true

bonuses_accrual_enabledbooleanpovinné

Příklad: true

bonuses_withdraw_enabledbooleanpovinné

Příklad: true

image_desktopstringpovinné

Příklad: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/medium/ec5b325fc4aa11721ecae38ae841f90b.jpg?v1745505855

image_mobilestringpovinné

Příklad: https://cdn.foodsoul.test/zones/ru/branches/8920/images/items/mobile/e12a68ed472cefd7ba68daaf6299ec2f.jpg?v1745505855

sortintegerpovinné

Příklad: 1

date_availablestring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Příklad: 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_idintegerpovinné

Příklad: 3389048

compositionobject (TranslationField)

defaultstring

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

Příklad: ru

translationsobjectpovinné

Hodnota podle kódu jazyka; pokud překlad chybí — klíč není

Hodnoty slovníku

string

modifiers_multiplier_enabledbooleanpovinné

Příklad: true

hide_cost_if_zero_enabledbooleanpovinné

Příklad: true

only_informing_enabledbooleanpovinné

Příklad: true

excise_enabledboolean

Příklad: true

typestring

Hodnoty:bouquetproductcombodishdrinkgift

Příklad: product

parametersarray of objectpovinné

idintegerpovinné

Příklad: 1

descriptionstring

Příklad: tasty, with onion

measure_idinteger

Příklad: 1

measure_indexintegerpovinné

Příklad: 1

old_costnumberpovinné

Příklad: 100

costnumberpovinné

Příklad: 90

bonusesnumberpovinné

Příklad: 90

vendor_codestring

Příklad: d1763be5-76a6-4ddb-8e11-3a1f91de199c::d835bcc9-1349-4911-af1d-131fd73144e5

sortintegerpovinné

Příklad: 1

modifiers_groups_idsarray of integer

proteinsinteger

Příklad: 10

fatsinteger

Příklad: 10

carbohydratesinteger

Příklad: 10

caloriesinteger

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } ] } ] } }