Obtenir la liste des articles

GET/api/crm/v2/itemsv2

operationId: items.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

category_idinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

branch_idinteger

Exemple: 1

automation_have_importboolean

Exemple: true

sizesobject

image_mobileobject

widthinteger

Exemple: 750

heightinteger

Exemple: 300

image_desktopobject

widthinteger

Exemple: 1500

heightinteger

Exemple: 1500

listarray of object

idintegerobligatoire

Exemple: 18085142

nameobject (TranslationField) obligatoire

Champ traduisible du catalogue ; structure identique dans la réponse et la requête.
Lors de la création, chaque langue du réseau absente de translations reste vide et est mise en file d’attente pour une traduction automatique par IA.
Lors de la modification, seules les langues présentes dans translations sont enregistrées : une langue absente de l’objet conserve sa valeur précédente si l’original n’a pas changé ; une valeur vide efface la traduction et la met en file d’attente pour une traduction automatique par IA.
La modification de l’original efface les traductions inchangées reçues — elles ne correspondent plus à l’original ; une traduction transmise avec une valeur différente est conservée comme correction manuelle. Cette suppression n’a lieu que si la traduction automatique est activée pour le réseau.
Une valeur dans une langue non publiée est rejetée ; une valeur dans une langue hors du jeu de langues du réseau est ignorée.

defaultstring

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

Exemple: ru

translationsobjectobligatoire

Valeur par code de langue ; pas de traduction — pas de clé

Valeurs du dictionnaire

string

separate_export_enabledbooleanobligatoire

Exemple: true

publishedbooleanobligatoire

Exemple: true

discount_enabledbooleanobligatoire

Exemple: true

recommend_enabledbooleanobligatoire

Exemple: false

stock_balance_enabledbooleanobligatoire

Exemple: false

free_delivery_enabledbooleanobligatoire

Exemple: true

minimum_sum_enabledbooleanobligatoire

Exemple: true

popular_enabledbooleanobligatoire

Exemple: true

bonuses_accrual_enabledbooleanobligatoire

Exemple: true

bonuses_withdraw_enabledbooleanobligatoire

Exemple: true

image_desktopstringobligatoire

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

image_mobilestringobligatoire

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

sortintegerobligatoire

Exemple: 1

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

Exemple: 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_idintegerobligatoire

Exemple: 3389048

compositionobject (TranslationField)

defaultstring

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

Exemple: ru

translationsobjectobligatoire

Valeur par code de langue ; pas de traduction — pas de clé

Valeurs du dictionnaire

string

modifiers_multiplier_enabledbooleanobligatoire

Exemple: true

hide_cost_if_zero_enabledbooleanobligatoire

Exemple: true

only_informing_enabledbooleanobligatoire

Exemple: true

excise_enabledboolean

Exemple: true

typestring

Valeurs:bouquetproductcombodishdrinkgift

Exemple: product

parametersarray of objectobligatoire

idintegerobligatoire

Exemple: 1

descriptionstring

Exemple: tasty, with onion

measure_idinteger

Exemple: 1

measure_indexintegerobligatoire

Exemple: 1

old_costnumberobligatoire

Exemple: 100

costnumberobligatoire

Exemple: 90

bonusesnumberobligatoire

Exemple: 90

vendor_codestring

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

sortintegerobligatoire

Exemple: 1

modifiers_groups_idsarray of integer

proteinsinteger

Exemple: 10

fatsinteger

Exemple: 10

carbohydratesinteger

Exemple: 10

caloriesinteger

Exemple: 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' => 'fr', '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": "fr", "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": "fr", "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 } ] } ] } }