Iegūt papildu pārdošanas avotu sarakstu

GET/api/crm/v2/additional_salesv2

operationId: additionalSales.default

Atgriež filiāles papildu pārdošanas avotu sarakstu ar filtrēšanu pēc avota veida (item, item_parameter, category). Katram avotam tiek atgriezti saistītie produkti, kategorijas un produktu parametri; saraksts ir sakārtots un sadalīts lapās.

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 1

link_typestring

Vērtības:itemitem_parametercategory

page_numberinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobjectobligāts

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

link_typeobject

typestringobligāts

Piemērs: radio

optionarray of string

listarray of object

link_itemobjectobligāts

idintegerobligāts

Piemērs: 1

typestringobligāts

Vērtības:itemitem_parametercategory

Piemērs: item

namestringobligāts

Piemērs: Example item

strategystringvar būt null

Stratēģija, kas izveidoja avotu; null — izveidots manuāli

Vērtības:sales_statisticsai_compatibilityai_prompt

Piemērs: sales_statistics

related_objectsarray of objectobligāts

idintegerobligāts

Piemērs: 1

typestringobligāts

Vērtības:itemitem_parametercategory

Piemērs: item

namestringobligāts

Piemērs: Recommended item

strategystringvar būt null

Stratēģija, kas izveidoja saiti; null — pievienots manuāli

Vērtības:sales_statisticsai_compatibilityai_prompt

Piemērs: ai_compatibility

sortintegerobligāts

Piemērs: 1

idintegerobligāts

Piemērs: 1

paginationobject (Pagination)

max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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 } } }