Obtener la lista de productos

GET/api/crm/v2/itemsv2

operationId: items.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

category_idinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

branch_idinteger

Ejemplo: 1

automation_have_importboolean

Ejemplo: true

sizesobject

image_mobileobject

widthinteger

Ejemplo: 750

heightinteger

Ejemplo: 300

image_desktopobject

widthinteger

Ejemplo: 1500

heightinteger

Ejemplo: 1500

listarray of object

idintegerobligatorio

Ejemplo: 18085142

nameobject (TranslationField) obligatorio

Campo traducible del catálogo; tiene la misma estructura en la respuesta y en la solicitud.
Al crear, cada idioma de la red que no esté en translations permanece vacío y se pone en cola para traducción automática por IA.
Al modificar, solo se guardan los idiomas presentes en translations: un idioma que no esté en el objeto mantiene su valor anterior si el original no ha cambiado; un valor vacío elimina la traducción y la pone en cola para traducción automática por IA.
El cambio del original elimina las traducciones que no hayan sido modificadas, ya que ya no corresponden al original; una traducción enviada con un valor diferente se guarda como corrección manual. Esta limpieza ocurre solo mientras la traducción automática esté habilitada en la red.
Un valor en un idioma no publicado es rechazado; un valor en un idioma fuera del conjunto de idiomas de la red es ignorado.

defaultstring

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

Ejemplo: ru

translationsobjectobligatorio

Valor por código de idioma; si no hay traducción, no hay clave

Valores del diccionario

string

separate_export_enabledbooleanobligatorio

Ejemplo: true

publishedbooleanobligatorio

Ejemplo: true

discount_enabledbooleanobligatorio

Ejemplo: true

recommend_enabledbooleanobligatorio

Ejemplo: false

stock_balance_enabledbooleanobligatorio

Ejemplo: false

free_delivery_enabledbooleanobligatorio

Ejemplo: true

minimum_sum_enabledbooleanobligatorio

Ejemplo: true

popular_enabledbooleanobligatorio

Ejemplo: true

bonuses_accrual_enabledbooleanobligatorio

Ejemplo: true

bonuses_withdraw_enabledbooleanobligatorio

Ejemplo: true

image_desktopstringobligatorio

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

image_mobilestringobligatorio

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

sortintegerobligatorio

Ejemplo: 1

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

Ejemplo: 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_idintegerobligatorio

Ejemplo: 3389048

compositionobject (TranslationField)

defaultstring

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

Ejemplo: ru

translationsobjectobligatorio

Valor por código de idioma; si no hay traducción, no hay clave

Valores del diccionario

string

modifiers_multiplier_enabledbooleanobligatorio

Ejemplo: true

hide_cost_if_zero_enabledbooleanobligatorio

Ejemplo: true

only_informing_enabledbooleanobligatorio

Ejemplo: true

excise_enabledboolean

Ejemplo: true

typestring

Valores:bouquetproductcombodishdrinkgift

Ejemplo: product

parametersarray of objectobligatorio

idintegerobligatorio

Ejemplo: 1

descriptionstring

Ejemplo: tasty, with onion

measure_idinteger

Ejemplo: 1

measure_indexintegerobligatorio

Ejemplo: 1

old_costnumberobligatorio

Ejemplo: 100

costnumberobligatorio

Ejemplo: 90

bonusesnumberobligatorio

Ejemplo: 90

vendor_codestring

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

sortintegerobligatorio

Ejemplo: 1

modifiers_groups_idsarray of integer

proteinsinteger

Ejemplo: 10

fatsinteger

Ejemplo: 10

carbohydratesinteger

Ejemplo: 10

caloriesinteger

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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 } ] } ] } }