Get couriers on the map

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Returns couriers for the map. Active courier orders do not include orders with statuses not_processed, canceled, or done. The branch city coordinates are also returned to center the map.

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 8779

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

listarray of object

idintegerrequired

Example: 1

namestringrequired

Example: Petr

phonestring

Example: +9 999-999-99-99

latitudenumber

Example: 55.782048128903

longitudenumber

Example: 37.558031208903

timestampinteger

Example: 1707217864

ordersarray of object

idinteger

Example: 15

order_numberinteger

Example: 123456

cityobject

latitudenumberrequired

Example: 55.782048128903

longitudenumberrequired

Example: 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' => 'en', '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": "en", "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": "en", "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 } } }