Liste der Zusatzverkaufsquellen abrufen

GET/api/crm/v2/additional_salesv2

operationId: additionalSales.default

Gibt eine Liste der Zusatzverkaufsquellen einer Filiale mit Filter nach Quellentyp (item, item_parameter, category) zurück. Für jede Quelle werden die zugehörigen Artikel, Kategorien und Artikelparameter zurückgegeben; die Liste ist sortiert und paginiert.

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

link_typestring

Werte:itemitem_parametercategory

page_numberinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobjecterforderlich

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

link_typeobject

typestringerforderlich

Beispiel: radio

optionarray of string

listarray of object

link_itemobjecterforderlich

idintegererforderlich

Beispiel: 1

typestringerforderlich

Werte:itemitem_parametercategory

Beispiel: item

namestringerforderlich

Beispiel: Example item

strategystringkann null sein

Strategie, die die Quelle erstellt hat; null — manuell erstellt

Werte:sales_statisticsai_compatibilityai_prompt

Beispiel: sales_statistics

related_objectsarray of objecterforderlich

idintegererforderlich

Beispiel: 1

typestringerforderlich

Werte:itemitem_parametercategory

Beispiel: item

namestringerforderlich

Beispiel: Recommended item

strategystringkann null sein

Strategie, die die Verknüpfung erstellt hat; null — manuell hinzugefügt

Werte:sales_statisticsai_compatibilityai_prompt

Beispiel: ai_compatibility

sortintegererforderlich

Beispiel: 1

idintegererforderlich

Beispiel: 1

paginationobject (Pagination)

max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: 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' => 'de', '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": "de", "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": "de", "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 } } }