Liste der Artikel abrufen

GET/api/crm/v2/itemsv2

operationId: items.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

category_idinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

branch_idinteger

Beispiel: 1

automation_have_importboolean

Beispiel: true

sizesobject

image_mobileobject

widthinteger

Beispiel: 750

heightinteger

Beispiel: 300

image_desktopobject

widthinteger

Beispiel: 1500

heightinteger

Beispiel: 1500

listarray of object

idintegererforderlich

Beispiel: 18085142

nameobject (TranslationField) erforderlich

Übersetzbares Katalogfeld; gleiche Struktur in Antwort und Anfrage.
Beim Erstellen bleibt jede Netzwerksprache, die nicht in translations enthalten ist, leer und wird zur AI-Übersetzung in die Warteschlange gestellt.
Beim Ändern werden nur die in translations enthaltenen Sprachen gespeichert: Eine Sprache, die nicht im Objekt enthalten ist, behält ihren bisherigen Wert, sofern das Original nicht geändert wurde; ein leerer Wert löscht die Übersetzung und stellt sie zur AI-Übersetzung in die Warteschlange.
Eine Änderung des Originals löscht Übersetzungen, die unverändert übermittelt wurden – sie entsprechen nicht mehr dem Original; eine Übersetzung mit geändertem Wert wird als manuelle Korrektur gespeichert. Diese Löschung erfolgt nur, solange die automatische Übersetzung im Netzwerk aktiviert ist.
Ein Wert in einer nicht veröffentlichten Sprache wird abgelehnt; ein Wert in einer Sprache außerhalb des Netzwerksatzes wird ignoriert.

defaultstring

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

Beispiel: ru

translationsobjecterforderlich

Wert nach Sprachcode; keine Übersetzung – kein Schlüssel

Werte des Wörterbuchs

string

separate_export_enabledbooleanerforderlich

Beispiel: true

publishedbooleanerforderlich

Beispiel: true

discount_enabledbooleanerforderlich

Beispiel: true

recommend_enabledbooleanerforderlich

Beispiel: false

stock_balance_enabledbooleanerforderlich

Beispiel: false

free_delivery_enabledbooleanerforderlich

Beispiel: true

minimum_sum_enabledbooleanerforderlich

Beispiel: true

popular_enabledbooleanerforderlich

Beispiel: true

bonuses_accrual_enabledbooleanerforderlich

Beispiel: true

bonuses_withdraw_enabledbooleanerforderlich

Beispiel: true

image_desktopstringerforderlich

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

image_mobilestringerforderlich

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

sortintegererforderlich

Beispiel: 1

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

Beispiel: 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_idintegererforderlich

Beispiel: 3389048

compositionobject (TranslationField)

defaultstring

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

Beispiel: ru

translationsobjecterforderlich

Wert nach Sprachcode; keine Übersetzung – kein Schlüssel

Werte des Wörterbuchs

string

modifiers_multiplier_enabledbooleanerforderlich

Beispiel: true

hide_cost_if_zero_enabledbooleanerforderlich

Beispiel: true

only_informing_enabledbooleanerforderlich

Beispiel: true

excise_enabledboolean

Beispiel: true

typestring

Werte:bouquetproductcombodishdrinkgift

Beispiel: product

parametersarray of objecterforderlich

idintegererforderlich

Beispiel: 1

descriptionstring

Beispiel: tasty, with onion

measure_idinteger

Beispiel: 1

measure_indexintegererforderlich

Beispiel: 1

old_costnumbererforderlich

Beispiel: 100

costnumbererforderlich

Beispiel: 90

bonusesnumbererforderlich

Beispiel: 90

vendor_codestring

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

sortintegererforderlich

Beispiel: 1

modifiers_groups_idsarray of integer

proteinsinteger

Beispiel: 10

fatsinteger

Beispiel: 10

carbohydratesinteger

Beispiel: 10

caloriesinteger

Beispiel: 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' => 'de', '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": "de", "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": "de", "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 } ] } ] } }