Получить курьеров на карте

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Возвращает курьеров для карты. В активные заказы курьера не входят заказы в статусах not_processed, canceled и done. Также возвращаются координаты города филиала, чтобы отцентрировать карту.

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 8779

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

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

namestringобязательный

Пример: Petr

phonestring

Пример: +9 999-999-99-99

latitudenumber

Пример: 55.782048128903

longitudenumber

Пример: 37.558031208903

timestampinteger

Пример: 1707217864

ordersarray of object

idinteger

Пример: 15

order_numberinteger

Пример: 123456

cityobject

latitudenumberобязательный

Пример: 55.782048128903

longitudenumberобязательный

Пример: 37.558031208903

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/couriers_map_real_time', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/couriers_map_real_time", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/couriers_map_real_time", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "list": [ { "id": 1, "name": "Petr", "phone": "+9 999-999-99-99", "latitude": 55.782048128903, "longitude": 37.558031208903, "timestamp": 1707217864, "orders": [ { "id": 15, "order_number": 123456 } ] } ], "city": { "latitude": 55.782048128903, "longitude": 37.558031208903 } } }