Obter a lista de itens

GET/api/crm/v2/itemsv2

operationId: items.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

category_idinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

branch_idinteger

Exemplo: 1

automation_have_importboolean

Exemplo: true

sizesobject

image_mobileobject

widthinteger

Exemplo: 750

heightinteger

Exemplo: 300

image_desktopobject

widthinteger

Exemplo: 1500

heightinteger

Exemplo: 1500

listarray of object

idintegerobrigatório

Exemplo: 18085142

nameobject (TranslationField) obrigatório

Campo traduzível do catálogo; mesma estrutura na resposta e na solicitação.
Ao criar, cada idioma da rede que não estiver em translations permanece vazio e é colocado na fila para tradução por IA.
Ao atualizar, apenas os idiomas presentes em translations são gravados: um idioma ausente no objeto mantém o valor anterior, se o original não foi alterado; um valor vazio limpa a tradução e a coloca na fila para tradução por IA.
Alterar o original limpa as traduções que não foram modificadas — elas não correspondem mais ao original; uma tradução enviada com outro valor é salva como edição manual. Essa limpeza ocorre apenas enquanto a tradução automática estiver ativada na rede.
Um valor em um idioma não publicado é rejeitado; um valor em um idioma fora do conjunto de idiomas da rede é ignorado.

defaultstring

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

Exemplo: ru

translationsobjectobrigatório

Valor pelo código do idioma; sem tradução — sem chave

Valores do dicionário

string

separate_export_enabledbooleanobrigatório

Exemplo: true

publishedbooleanobrigatório

Exemplo: true

discount_enabledbooleanobrigatório

Exemplo: true

recommend_enabledbooleanobrigatório

Exemplo: false

stock_balance_enabledbooleanobrigatório

Exemplo: false

free_delivery_enabledbooleanobrigatório

Exemplo: true

minimum_sum_enabledbooleanobrigatório

Exemplo: true

popular_enabledbooleanobrigatório

Exemplo: true

bonuses_accrual_enabledbooleanobrigatório

Exemplo: true

bonuses_withdraw_enabledbooleanobrigatório

Exemplo: true

image_desktopstringobrigatório

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

image_mobilestringobrigatório

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

sortintegerobrigatório

Exemplo: 1

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

Exemplo: 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_idintegerobrigatório

Exemplo: 3389048

compositionobject (TranslationField)

defaultstring

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

Exemplo: ru

translationsobjectobrigatório

Valor pelo código do idioma; sem tradução — sem chave

Valores do dicionário

string

modifiers_multiplier_enabledbooleanobrigatório

Exemplo: true

hide_cost_if_zero_enabledbooleanobrigatório

Exemplo: true

only_informing_enabledbooleanobrigatório

Exemplo: true

excise_enabledboolean

Exemplo: true

typestring

Valores:bouquetproductcombodishdrinkgift

Exemplo: product

parametersarray of objectobrigatório

idintegerobrigatório

Exemplo: 1

descriptionstring

Exemplo: tasty, with onion

measure_idinteger

Exemplo: 1

measure_indexintegerobrigatório

Exemplo: 1

old_costnumberobrigatório

Exemplo: 100

costnumberobrigatório

Exemplo: 90

bonusesnumberobrigatório

Exemplo: 90

vendor_codestring

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

sortintegerobrigatório

Exemplo: 1

modifiers_groups_idsarray of integer

proteinsinteger

Exemplo: 10

fatsinteger

Exemplo: 10

carbohydratesinteger

Exemplo: 10

caloriesinteger

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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 } ] } ] } }