Hangi saada kaupade loend

GET/api/crm/v2/itemsv2

operationId: items.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idinteger

Näide: 1

category_idinteger

Näide: 1

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

branch_idinteger

Näide: 1

automation_have_importboolean

Näide: true

sizesobject

image_mobileobject

widthinteger

Näide: 750

heightinteger

Näide: 300

image_desktopobject

widthinteger

Näide: 1500

heightinteger

Näide: 1500

listarray of object

idintegerkohustuslik

Näide: 18085142

nameobject (TranslationField) kohustuslik

Tõlgitav kataloogi väli; sama struktuur vastuses ja päringus.
Loomisel jääb iga võrgu keel, mida pole translations sees, tühjaks ja lisatakse AI-tõlke järjekorda.
Muutmisel salvestatakse ainult keeled, mis on translations sees: keel, mida objektis pole, säilitab eelmise väärtuse, kui originaal pole muutunud; tühi väärtus puhastab tõlke ja lisab selle AI-tõlke järjekorda.
Originaali muutmine puhastab tõlked, mis tulid muutmata kujul — need ei vasta enam originaalile; tõlge, mis on saadetud teise väärtusega, salvestatakse käsitsi parandatuna. Selline puhastamine toimub ainult siis, kui võrgus on automaattõlge sisse lülitatud.
Avaldamata keeles väärtus lükatakse tagasi; väärtus keeles, mis pole võrgu keelte hulgas, jäetakse tähelepanuta.

defaultstring

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

Näide: ru

translationsobjectkohustuslik

Väärtus keelekoodi järgi; kui tõlge puudub — võtit pole

Sõnastiku väärtused

string

separate_export_enabledbooleankohustuslik

Näide: true

publishedbooleankohustuslik

Näide: true

discount_enabledbooleankohustuslik

Näide: true

recommend_enabledbooleankohustuslik

Näide: false

stock_balance_enabledbooleankohustuslik

Näide: false

free_delivery_enabledbooleankohustuslik

Näide: true

minimum_sum_enabledbooleankohustuslik

Näide: true

popular_enabledbooleankohustuslik

Näide: true

bonuses_accrual_enabledbooleankohustuslik

Näide: true

bonuses_withdraw_enabledbooleankohustuslik

Näide: true

image_desktopstringkohustuslik

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

image_mobilestringkohustuslik

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

sortintegerkohustuslik

Näide: 1

date_availablestring (DataTimeFormatSQL)

Näide: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Näide: 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_idintegerkohustuslik

Näide: 3389048

compositionobject (TranslationField)

defaultstring

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

Näide: ru

translationsobjectkohustuslik

Väärtus keelekoodi järgi; kui tõlge puudub — võtit pole

Sõnastiku väärtused

string

modifiers_multiplier_enabledbooleankohustuslik

Näide: true

hide_cost_if_zero_enabledbooleankohustuslik

Näide: true

only_informing_enabledbooleankohustuslik

Näide: true

excise_enabledboolean

Näide: true

typestring

Väärtused:bouquetproductcombodishdrinkgift

Näide: product

parametersarray of objectkohustuslik

idintegerkohustuslik

Näide: 1

descriptionstring

Näide: tasty, with onion

measure_idinteger

Näide: 1

measure_indexintegerkohustuslik

Näide: 1

old_costnumberkohustuslik

Näide: 100

costnumberkohustuslik

Näide: 90

bonusesnumberkohustuslik

Näide: 90

vendor_codestring

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

sortintegerkohustuslik

Näide: 1

modifiers_groups_idsarray of integer

proteinsinteger

Näide: 10

fatsinteger

Näide: 10

carbohydratesinteger

Näide: 10

caloriesinteger

Näide: 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' => 'et', '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": "et", "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": "et", "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 } ] } ] } }