Отримати список джерел додаткових продажів

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.pro/api/crm/v2/additional_sales', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'uk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/additional_sales", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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 } } }