Получить список источников дополнительных продаж

GET/api/crm/v2/additional_salesv2

operationId: additionalSales.default

Возвращает список источников дополнительных продаж филиала с фильтром по типу источника (item, item_parameter, category). Для каждого источника возвращаются связанные товары, категории и параметры товаров; список отсортирован и разбит на страницы.

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 1

link_typestring

Значения:itemitem_parametercategory

page_numberinteger

Пример: 1

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobjectобязательный

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

link_typeobject

typestringобязательный

Пример: radio

optionarray of string

listarray of object

link_itemobjectобязательный

idintegerобязательный

Пример: 1

typestringобязательный

Значения:itemitem_parametercategory

Пример: item

namestringобязательный

Пример: Example item

strategystringможет быть null

Стратегия, создавшая источник; null — создан вручную

Значения:sales_statisticsai_compatibilityai_prompt

Пример: sales_statistics

related_objectsarray of objectобязательный

idintegerобязательный

Пример: 1

typestringобязательный

Значения:itemitem_parametercategory

Пример: item

namestringобязательный

Пример: Recommended item

strategystringможет быть null

Стратегия, создавшая связь; null — добавлена вручную

Значения:sales_statisticsai_compatibilityai_prompt

Пример: ai_compatibility

sortintegerобязательный

Пример: 1

idintegerобязательный

Пример: 1

paginationobject (Pagination)

max_countintegerобязательный

Количество элементов на странице

Пример: 30

page_numberintegerобязательный

Номер текущей страницы; ограничен так, чтобы смещение не превышало 1000

Пример: 1

has_nextbooleanобязательный

Есть ли следующая страница

Пример: true

has_previousbooleanобязательный

Есть ли предыдущая страница

Пример: false

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/additional_sales', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/additional_sales", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/additional_sales", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "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" }, "link_type": { "type": "radio", "option": [ "item" ] } }, "list": [ { "link_item": { "id": 1, "type": "item", "name": "Example item" }, "strategy": "sales_statistics", "related_objects": [ { "id": 1, "type": "item", "name": "Recommended item", "strategy": "ai_compatibility" } ], "sort": 1, "id": 1 } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }