Ottenere l'elenco degli articoli

GET/api/crm/v2/itemsv2

operationId: items.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 1

category_idinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

branch_idinteger

Esempio: 1

automation_have_importboolean

Esempio: true

sizesobject

image_mobileobject

widthinteger

Esempio: 750

heightinteger

Esempio: 300

image_desktopobject

widthinteger

Esempio: 1500

heightinteger

Esempio: 1500

listarray of object

idintegerobbligatorio

Esempio: 18085142

nameobject (TranslationField) obbligatorio

Campo traducibile del catalogo; la struttura è identica sia nella risposta che nella richiesta.
Alla creazione, ogni lingua della rete assente in translations rimane vuota e viene messa in coda per la traduzione AI.
In caso di modifica, vengono salvate solo le lingue presenti in translations: una lingua assente nell’oggetto mantiene il valore precedente, se l’originale non è cambiato; un valore vuoto cancella la traduzione e la mette in coda per la traduzione AI.
La modifica dell’originale cancella le traduzioni che arrivano senza modifiche — non corrispondono più all’originale; una traduzione inviata con un valore diverso viene salvata come correzione manuale. Questa cancellazione avviene solo se la traduzione automatica è attiva nella rete.
Un valore in una lingua non pubblicata viene rifiutato; un valore in una lingua non inclusa nell’insieme delle lingue della rete viene ignorato.

defaultstring

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

Esempio: ru

translationsobjectobbligatorio

Valore per codice lingua; nessuna traduzione — nessuna chiave

Valori del dizionario

string

separate_export_enabledbooleanobbligatorio

Esempio: true

publishedbooleanobbligatorio

Esempio: true

discount_enabledbooleanobbligatorio

Esempio: true

recommend_enabledbooleanobbligatorio

Esempio: false

stock_balance_enabledbooleanobbligatorio

Esempio: false

free_delivery_enabledbooleanobbligatorio

Esempio: true

minimum_sum_enabledbooleanobbligatorio

Esempio: true

popular_enabledbooleanobbligatorio

Esempio: true

bonuses_accrual_enabledbooleanobbligatorio

Esempio: true

bonuses_withdraw_enabledbooleanobbligatorio

Esempio: true

image_desktopstringobbligatorio

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

image_mobilestringobbligatorio

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

sortintegerobbligatorio

Esempio: 1

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

Esempio: 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_idintegerobbligatorio

Esempio: 3389048

compositionobject (TranslationField)

defaultstring

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

Esempio: ru

translationsobjectobbligatorio

Valore per codice lingua; nessuna traduzione — nessuna chiave

Valori del dizionario

string

modifiers_multiplier_enabledbooleanobbligatorio

Esempio: true

hide_cost_if_zero_enabledbooleanobbligatorio

Esempio: true

only_informing_enabledbooleanobbligatorio

Esempio: true

excise_enabledboolean

Esempio: true

typestring

Valori:bouquetproductcombodishdrinkgift

Esempio: product

parametersarray of objectobbligatorio

idintegerobbligatorio

Esempio: 1

descriptionstring

Esempio: tasty, with onion

measure_idinteger

Esempio: 1

measure_indexintegerobbligatorio

Esempio: 1

old_costnumberobbligatorio

Esempio: 100

costnumberobbligatorio

Esempio: 90

bonusesnumberobbligatorio

Esempio: 90

vendor_codestring

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

sortintegerobbligatorio

Esempio: 1

modifiers_groups_idsarray of integer

proteinsinteger

Esempio: 10

fatsinteger

Esempio: 10

carbohydratesinteger

Esempio: 10

caloriesinteger

Esempio: 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' => 'it', '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": "it", "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": "it", "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 } ] } ] } }