Hangi filiaalide loendi saamine

GET/api/crm/v2/branchesv2

operationId: branches.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

page_numberinteger

Näide: 1

chain_idinteger

branch_idinteger

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

Üks variantidest

object

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

listarray of object

idintegerkohustuslik

Näide: 1

datestring (DataTimeFormatSQL) kohustuslik

Näide: 2024-05-02 08:31:16

branch_namestring

Näide: Don't touch

chain_idintegerkohustuslik

Näide: 1

publishedbooleankohustuslik

Näide: true

branch_balancenumberkohustuslik

Näide: 1000

feedback_enabledbooleankohustuslik

Näide: true

email_for_feedbackstring

Näide: example@example.com

preorder_in_work_timeboolean

Näide: true

preorder_enableboolean

Näide: true

preorder_alwaysboolean

Näide: true

preorder_delivery_minimum_minutesinteger

Näide: 0

preorder_delivery_maximum_daysinteger

Näide: 3

preorder_pickup_minimum_minutesinteger

Näide: 10

preorder_pickup_maximum_daysinteger

Näide: 1

order_auto_confirm_enabledboolean

Näide: true

order_auto_confirm_delay_minutes_weekdaysinteger

Näide: 30

order_auto_confirm_delay_minutes_weekendinteger

Näide: 60

order_auto_confirm_delay_minutes_holidaysinteger

Näide: 90

order_countdown_enabledboolean

Näide: true

phone_mask_enableboolean

Näide: true

phone_formatboolean

Näide: true

phone_internationalboolean

Näide: true

email_format_addressboolean

Näide: true

email_lite_versionboolean

Näide: true

email_include_photoboolean

Näide: true

email_permanent_clientboolean

Näide: true

invoice_splittedboolean

Näide: true

chain_namestringkohustuslik

Näide: Green Basket

repeat_order_notification_enabledbooleankohustuslik

Näide: true

show_category_enabledbooleankohustuslik

Näide: true

city_idintegerkohustuslik

Näide: 739

round_costs_modestringkohustuslik

Väärtused:half_uphalf_downhalf_evenceilingfloor

Näide: half_even

round_costs_to_precisionintegerkohustuslik

Näide: 2

account_idintegerkohustuslik

Näide: 1

account_balancenumberkohustuslik

Näide: 0.01

blocking_statusstringkohustuslik

Väärtused:activatedblockedfrozen

Näide: activated

city_namestringkohustuslik

Näide: London

tokenstringkohustuslik

Näide: f86e6fbdb2db6f1f97b99650e19669eb

paginationobject (Pagination)

max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false

tg_bot_namestring

Näide: fs_feedback_notifications_bot

max_bot_namestring

Näide: 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' => 'et', '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": "et", "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": "et", "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" } }