Obtener la lista de sucursales

GET/api/crm/v2/branchesv2

operationId: branches.default

Autorización

api-token + language + role

Parámetros de consulta

page_numberinteger

Ejemplo: 1

chain_idinteger

branch_idinteger

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

Una de las opciones

object

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 1

datestring (DataTimeFormatSQL) obligatorio

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

branch_namestring

Ejemplo: Don't touch

chain_idintegerobligatorio

Ejemplo: 1

publishedbooleanobligatorio

Ejemplo: true

branch_balancenumberobligatorio

Ejemplo: 1000

feedback_enabledbooleanobligatorio

Ejemplo: true

email_for_feedbackstring

Ejemplo: example@example.com

preorder_in_work_timeboolean

Ejemplo: true

preorder_enableboolean

Ejemplo: true

preorder_alwaysboolean

Ejemplo: true

preorder_delivery_minimum_minutesinteger

Ejemplo: 0

preorder_delivery_maximum_daysinteger

Ejemplo: 3

preorder_pickup_minimum_minutesinteger

Ejemplo: 10

preorder_pickup_maximum_daysinteger

Ejemplo: 1

order_auto_confirm_enabledboolean

Ejemplo: true

order_auto_confirm_delay_minutes_weekdaysinteger

Ejemplo: 30

order_auto_confirm_delay_minutes_weekendinteger

Ejemplo: 60

order_auto_confirm_delay_minutes_holidaysinteger

Ejemplo: 90

order_countdown_enabledboolean

Ejemplo: true

phone_mask_enableboolean

Ejemplo: true

phone_formatboolean

Ejemplo: true

phone_internationalboolean

Ejemplo: true

email_format_addressboolean

Ejemplo: true

email_lite_versionboolean

Ejemplo: true

email_include_photoboolean

Ejemplo: true

email_permanent_clientboolean

Ejemplo: true

invoice_splittedboolean

Ejemplo: true

chain_namestringobligatorio

Ejemplo: Green Basket

repeat_order_notification_enabledbooleanobligatorio

Ejemplo: true

show_category_enabledbooleanobligatorio

Ejemplo: true

city_idintegerobligatorio

Ejemplo: 739

round_costs_modestringobligatorio

Valores:half_uphalf_downhalf_evenceilingfloor

Ejemplo: half_even

round_costs_to_precisionintegerobligatorio

Ejemplo: 2

account_idintegerobligatorio

Ejemplo: 1

account_balancenumberobligatorio

Ejemplo: 0.01

blocking_statusstringobligatorio

Valores:activatedblockedfrozen

Ejemplo: activated

city_namestringobligatorio

Ejemplo: London

tokenstringobligatorio

Ejemplo: f86e6fbdb2db6f1f97b99650e19669eb

paginationobject (Pagination)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false

tg_bot_namestring

Ejemplo: fs_feedback_notifications_bot

max_bot_namestring

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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" } }