Gauti prekių sąrašą

GET/api/crm/v2/itemsv2

operationId: items.default

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 1

category_idinteger

Pavyzdys: 1

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

branch_idinteger

Pavyzdys: 1

automation_have_importboolean

Pavyzdys: true

sizesobject

image_mobileobject

widthinteger

Pavyzdys: 750

heightinteger

Pavyzdys: 300

image_desktopobject

widthinteger

Pavyzdys: 1500

heightinteger

Pavyzdys: 1500

listarray of object

idintegerprivalomas

Pavyzdys: 18085142

nameobject (TranslationField) privalomas

Verčiamas katalogo laukas; struktūra vienoda tiek atsakyme, tiek užklausoje.
Kuriant kiekviena tinklo kalba, kurios nėra translations, lieka tuščia ir įtraukiama į AI vertimo eilę.
Keičiant įrašomi tik translations esantys kalbos: kalba, kurios nėra objekte, išlaiko ankstesnę reikšmę, jei originalas nepasikeitė; tuščia reikšmė išvalo vertimą ir įtraukia jį į AI vertimo eilę.
Originalo pakeitimas išvalo vertimus, kurie nebuvo pakeisti — jie nebeatitinka originalo; vertimas, perduotas su kita reikšme, išsaugomas kaip rankinis taisymas. Toks išvalymas vyksta tik tada, kai tinkle įjungtas automatinis vertimas.
Reikšmė nepublikuota kalba atmetama; reikšmė kalba, kuri nėra tinklo kalbų rinkinyje, ignoruojama.

defaultstring

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

Pavyzdys: ru

translationsobjectprivalomas

Vertė pagal kalbos kodą; nėra vertimo — nėra rakto

Žodyno reikšmės

string

separate_export_enabledbooleanprivalomas

Pavyzdys: true

publishedbooleanprivalomas

Pavyzdys: true

discount_enabledbooleanprivalomas

Pavyzdys: true

recommend_enabledbooleanprivalomas

Pavyzdys: false

stock_balance_enabledbooleanprivalomas

Pavyzdys: false

free_delivery_enabledbooleanprivalomas

Pavyzdys: true

minimum_sum_enabledbooleanprivalomas

Pavyzdys: true

popular_enabledbooleanprivalomas

Pavyzdys: true

bonuses_accrual_enabledbooleanprivalomas

Pavyzdys: true

bonuses_withdraw_enabledbooleanprivalomas

Pavyzdys: true

image_desktopstringprivalomas

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

image_mobilestringprivalomas

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

sortintegerprivalomas

Pavyzdys: 1

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

Pavyzdys: 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_idintegerprivalomas

Pavyzdys: 3389048

compositionobject (TranslationField)

defaultstring

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

Pavyzdys: ru

translationsobjectprivalomas

Vertė pagal kalbos kodą; nėra vertimo — nėra rakto

Žodyno reikšmės

string

modifiers_multiplier_enabledbooleanprivalomas

Pavyzdys: true

hide_cost_if_zero_enabledbooleanprivalomas

Pavyzdys: true

only_informing_enabledbooleanprivalomas

Pavyzdys: true

excise_enabledboolean

Pavyzdys: true

typestring

Reikšmės:bouquetproductcombodishdrinkgift

Pavyzdys: product

parametersarray of objectprivalomas

idintegerprivalomas

Pavyzdys: 1

descriptionstring

Pavyzdys: tasty, with onion

measure_idinteger

Pavyzdys: 1

measure_indexintegerprivalomas

Pavyzdys: 1

old_costnumberprivalomas

Pavyzdys: 100

costnumberprivalomas

Pavyzdys: 90

bonusesnumberprivalomas

Pavyzdys: 90

vendor_codestring

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

sortintegerprivalomas

Pavyzdys: 1

modifiers_groups_idsarray of integer

proteinsinteger

Pavyzdys: 10

fatsinteger

Pavyzdys: 10

carbohydratesinteger

Pavyzdys: 10

caloriesinteger

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