Získat seznam poboček

GET/api/crm/v2/branchesv2

operationId: branches.default

Autorizace

api-token + language + role

Parametry dotazu

page_numberinteger

Příklad: 1

chain_idinteger

branch_idinteger

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

Jedna z možností

object

filtersobject

branch_idobject (FilterSelectInteger)

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

listarray of object

idintegerpovinné

Příklad: 1

datestring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

branch_namestring

Příklad: Don't touch

chain_idintegerpovinné

Příklad: 1

publishedbooleanpovinné

Příklad: true

branch_balancenumberpovinné

Příklad: 1000

feedback_enabledbooleanpovinné

Příklad: true

email_for_feedbackstring

Příklad: example@example.com

preorder_in_work_timeboolean

Příklad: true

preorder_enableboolean

Příklad: true

preorder_alwaysboolean

Příklad: true

preorder_delivery_minimum_minutesinteger

Příklad: 0

preorder_delivery_maximum_daysinteger

Příklad: 3

preorder_pickup_minimum_minutesinteger

Příklad: 10

preorder_pickup_maximum_daysinteger

Příklad: 1

order_auto_confirm_enabledboolean

Příklad: true

order_auto_confirm_delay_minutes_weekdaysinteger

Příklad: 30

order_auto_confirm_delay_minutes_weekendinteger

Příklad: 60

order_auto_confirm_delay_minutes_holidaysinteger

Příklad: 90

order_countdown_enabledboolean

Příklad: true

phone_mask_enableboolean

Příklad: true

phone_formatboolean

Příklad: true

phone_internationalboolean

Příklad: true

email_format_addressboolean

Příklad: true

email_lite_versionboolean

Příklad: true

email_include_photoboolean

Příklad: true

email_permanent_clientboolean

Příklad: true

invoice_splittedboolean

Příklad: true

chain_namestringpovinné

Příklad: Green Basket

repeat_order_notification_enabledbooleanpovinné

Příklad: true

show_category_enabledbooleanpovinné

Příklad: true

city_idintegerpovinné

Příklad: 739

round_costs_modestringpovinné

Hodnoty:half_uphalf_downhalf_evenceilingfloor

Příklad: half_even

round_costs_to_precisionintegerpovinné

Příklad: 2

account_idintegerpovinné

Příklad: 1

account_balancenumberpovinné

Příklad: 0.01

blocking_statusstringpovinné

Hodnoty:activatedblockedfrozen

Příklad: activated

city_namestringpovinné

Příklad: London

tokenstringpovinné

Příklad: f86e6fbdb2db6f1f97b99650e19669eb

paginationobject (Pagination)

max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: false

tg_bot_namestring

Příklad: fs_feedback_notifications_bot

max_bot_namestring

Příklad: fs_feedback_notifications_bot

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/branches', [ '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/branches", { 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/branches", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "cs", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ {} ], "mode": "value_required" } }, "list": [ { "id": 1, "date": "2024-05-02 08:31:16", "branch_name": "Don't touch", "chain_id": 1, "published": true, "branch_balance": 1000, "feedback_enabled": true, "email_for_feedback": "example@example.com", "preorder_in_work_time": true, "preorder_enable": true, "preorder_always": true, "preorder_delivery_minimum_minutes": 0, "preorder_delivery_maximum_days": 3, "preorder_pickup_minimum_minutes": 10, "preorder_pickup_maximum_days": 1, "order_auto_confirm_enabled": true, "order_auto_confirm_delay_minutes_weekdays": 30, "order_auto_confirm_delay_minutes_weekend": 60, "order_auto_confirm_delay_minutes_holidays": 90, "order_countdown_enabled": true, "phone_mask_enable": true, "phone_format": true, "phone_international": true, "email_format_address": true, "email_lite_version": true, "email_include_photo": true, "email_permanent_client": true, "invoice_splitted": true, "chain_name": "Green Basket", "repeat_order_notification_enabled": true, "show_category_enabled": true, "city_id": 739, "round_costs_mode": "half_even", "round_costs_to_precision": 2, "account_id": 1, "account_balance": 0.01, "blocking_status": "activated", "city_name": "London", "token": "f86e6fbdb2db6f1f97b99650e19669eb" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "tg_bot_name": "fs_feedback_notifications_bot", "max_bot_name": "fs_feedback_notifications_bot" } }