Získat referenční údaje pro doplňkový prodej

GET/api/crm/v2/additional_sales.fieldsv2

operationId: additionalSales.fields

Vrací referenční údaje pro formulář doplňkového prodeje pobočky: produkty (items), kategorie (categories) a parametry produktů (item_parameters) pro výběr zdroje nebo souvisejících objektů.

Autorizace

api-token + language + role

Parametry dotazu

branch_idintegerpovinné

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobjectpovinné

itemsobject (FilterSelectInteger) povinné

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

categoriesobject (FilterSelectInteger) povinné

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

item_parametersobject (FilterSelectInteger) povinné

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/additional_sales.fields?branch_id=1", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "cs", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "items": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "categories": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "item_parameters": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } } }