Iegūt preču sarakstu

GET/api/crm/v2/itemsv2

operationId: items.default

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 1

category_idinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

branch_idinteger

Piemērs: 1

automation_have_importboolean

Piemērs: true

sizesobject

image_mobileobject

widthinteger

Piemērs: 750

heightinteger

Piemērs: 300

image_desktopobject

widthinteger

Piemērs: 1500

heightinteger

Piemērs: 1500

listarray of object

idintegerobligāts

Piemērs: 18085142

nameobject (TranslationField) obligāts

Tulkotais lauks katalogā; vienādas struktūras atbildē un pieprasījumā.
Izveidojot katra tīkla valoda, kuras nav translations, paliek tukša un tiek ievietota rindā AI tulkojumam.
Mainot tiek saglabātas tikai tās valodas, kas ir translations: valoda, kuras nav objektā, saglabā iepriekšējo vērtību, ja oriģināls nav mainīts; tukša vērtība notīra tulkojumu un ievieto to rindā AI tulkojumam.
Oriģināla izmaiņa notīra tos tulkojumus, kas nav mainīti, — tie vairs neatbilst oriģinālam; tulkojums, kas nodots ar citu vērtību, tiek saglabāts kā manuāla korekcija. Šāda tīrīšana notiek tikai tad, ja tīklā ir ieslēgta automātiskā tulkošana.
Vērtība nepublicētā valodā tiek noraidīta; vērtība valodā ārpus tīkla valodu kopas tiek ignorēta.

defaultstring

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

Piemērs: ru

translationsobjectobligāts

Vērtība pēc valodas koda; nav tulkojuma — nav atslēgas

Vārdnīcas vērtības

string

separate_export_enabledbooleanobligāts

Piemērs: true

publishedbooleanobligāts

Piemērs: true

discount_enabledbooleanobligāts

Piemērs: true

recommend_enabledbooleanobligāts

Piemērs: false

stock_balance_enabledbooleanobligāts

Piemērs: false

free_delivery_enabledbooleanobligāts

Piemērs: true

minimum_sum_enabledbooleanobligāts

Piemērs: true

popular_enabledbooleanobligāts

Piemērs: true

bonuses_accrual_enabledbooleanobligāts

Piemērs: true

bonuses_withdraw_enabledbooleanobligāts

Piemērs: true

image_desktopstringobligāts

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

image_mobilestringobligāts

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

sortintegerobligāts

Piemērs: 1

date_availablestring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Piemērs: 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_idintegerobligāts

Piemērs: 3389048

compositionobject (TranslationField)

defaultstring

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

Piemērs: ru

translationsobjectobligāts

Vērtība pēc valodas koda; nav tulkojuma — nav atslēgas

Vārdnīcas vērtības

string

modifiers_multiplier_enabledbooleanobligāts

Piemērs: true

hide_cost_if_zero_enabledbooleanobligāts

Piemērs: true

only_informing_enabledbooleanobligāts

Piemērs: true

excise_enabledboolean

Piemērs: true

typestring

Vērtības:bouquetproductcombodishdrinkgift

Piemērs: product

parametersarray of objectobligāts

idintegerobligāts

Piemērs: 1

descriptionstring

Piemērs: tasty, with onion

measure_idinteger

Piemērs: 1

measure_indexintegerobligāts

Piemērs: 1

old_costnumberobligāts

Piemērs: 100

costnumberobligāts

Piemērs: 90

bonusesnumberobligāts

Piemērs: 90

vendor_codestring

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

sortintegerobligāts

Piemērs: 1

modifiers_groups_idsarray of integer

proteinsinteger

Piemērs: 10

fatsinteger

Piemērs: 10

carbohydratesinteger

Piemērs: 10

caloriesinteger

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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 } ] } ] } }