Отримати список філій

GET/api/crm/v2/branchesv2

operationId: branches.default

Авторизація

api-token + language + role

Параметри запиту

page_numberinteger

Приклад: 1

chain_idinteger

branch_idinteger

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

Один із варіантів

object

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

listarray of object

idintegerобов’язковий

Приклад: 1

datestring (DataTimeFormatSQL) обов’язковий

Приклад: 2024-05-02 08:31:16

branch_namestring

Приклад: Don't touch

chain_idintegerобов’язковий

Приклад: 1

publishedbooleanобов’язковий

Приклад: true

branch_balancenumberобов’язковий

Приклад: 1000

feedback_enabledbooleanобов’язковий

Приклад: true

email_for_feedbackstring

Приклад: example@example.com

preorder_in_work_timeboolean

Приклад: true

preorder_enableboolean

Приклад: true

preorder_alwaysboolean

Приклад: true

preorder_delivery_minimum_minutesinteger

Приклад: 0

preorder_delivery_maximum_daysinteger

Приклад: 3

preorder_pickup_minimum_minutesinteger

Приклад: 10

preorder_pickup_maximum_daysinteger

Приклад: 1

order_auto_confirm_enabledboolean

Приклад: true

order_auto_confirm_delay_minutes_weekdaysinteger

Приклад: 30

order_auto_confirm_delay_minutes_weekendinteger

Приклад: 60

order_auto_confirm_delay_minutes_holidaysinteger

Приклад: 90

order_countdown_enabledboolean

Приклад: true

phone_mask_enableboolean

Приклад: true

phone_formatboolean

Приклад: true

phone_internationalboolean

Приклад: true

email_format_addressboolean

Приклад: true

email_lite_versionboolean

Приклад: true

email_include_photoboolean

Приклад: true

email_permanent_clientboolean

Приклад: true

invoice_splittedboolean

Приклад: true

chain_namestringобов’язковий

Приклад: Green Basket

repeat_order_notification_enabledbooleanобов’язковий

Приклад: true

show_category_enabledbooleanобов’язковий

Приклад: true

city_idintegerобов’язковий

Приклад: 739

round_costs_modestringобов’язковий

Значення:half_uphalf_downhalf_evenceilingfloor

Приклад: half_even

round_costs_to_precisionintegerобов’язковий

Приклад: 2

account_idintegerобов’язковий

Приклад: 1

account_balancenumberобов’язковий

Приклад: 0.01

blocking_statusstringобов’язковий

Значення:activatedblockedfrozen

Приклад: activated

city_namestringобов’язковий

Приклад: London

tokenstringобов’язковий

Приклад: f86e6fbdb2db6f1f97b99650e19669eb

paginationobject (Pagination)

max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false

tg_bot_namestring

Приклад: fs_feedback_notifications_bot

max_bot_namestring

Приклад: 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' => 'uk', '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": "uk", "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": "uk", "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" } }