Obter a lista de filiais

GET/api/crm/v2/branchesv2

operationId: branches.default

Autorização

api-token + language + role

Parâmetros de consulta

page_numberinteger

Exemplo: 1

chain_idinteger

branch_idinteger

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

Uma das opções

object

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 1

datestring (DataTimeFormatSQL) obrigatório

Exemplo: 2024-05-02 08:31:16

branch_namestring

Exemplo: Don't touch

chain_idintegerobrigatório

Exemplo: 1

publishedbooleanobrigatório

Exemplo: true

branch_balancenumberobrigatório

Exemplo: 1000

feedback_enabledbooleanobrigatório

Exemplo: true

email_for_feedbackstring

Exemplo: example@example.com

preorder_in_work_timeboolean

Exemplo: true

preorder_enableboolean

Exemplo: true

preorder_alwaysboolean

Exemplo: true

preorder_delivery_minimum_minutesinteger

Exemplo: 0

preorder_delivery_maximum_daysinteger

Exemplo: 3

preorder_pickup_minimum_minutesinteger

Exemplo: 10

preorder_pickup_maximum_daysinteger

Exemplo: 1

order_auto_confirm_enabledboolean

Exemplo: true

order_auto_confirm_delay_minutes_weekdaysinteger

Exemplo: 30

order_auto_confirm_delay_minutes_weekendinteger

Exemplo: 60

order_auto_confirm_delay_minutes_holidaysinteger

Exemplo: 90

order_countdown_enabledboolean

Exemplo: true

phone_mask_enableboolean

Exemplo: true

phone_formatboolean

Exemplo: true

phone_internationalboolean

Exemplo: true

email_format_addressboolean

Exemplo: true

email_lite_versionboolean

Exemplo: true

email_include_photoboolean

Exemplo: true

email_permanent_clientboolean

Exemplo: true

invoice_splittedboolean

Exemplo: true

chain_namestringobrigatório

Exemplo: Green Basket

repeat_order_notification_enabledbooleanobrigatório

Exemplo: true

show_category_enabledbooleanobrigatório

Exemplo: true

city_idintegerobrigatório

Exemplo: 739

round_costs_modestringobrigatório

Valores:half_uphalf_downhalf_evenceilingfloor

Exemplo: half_even

round_costs_to_precisionintegerobrigatório

Exemplo: 2

account_idintegerobrigatório

Exemplo: 1

account_balancenumberobrigatório

Exemplo: 0.01

blocking_statusstringobrigatório

Valores:activatedblockedfrozen

Exemplo: activated

city_namestringobrigatório

Exemplo: London

tokenstringobrigatório

Exemplo: f86e6fbdb2db6f1f97b99650e19669eb

paginationobject (Pagination)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false

tg_bot_namestring

Exemplo: fs_feedback_notifications_bot

max_bot_namestring

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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" } }