Obtener repartidores en el mapa

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Devuelve los couriers para el mapa. En los pedidos activos del courier no se incluyen los pedidos con los estados not_processed, canceled y done. También se devuelven las coordenadas de la ciudad de la sucursal para centrar el mapa.

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 8779

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

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

namestringobligatorio

Ejemplo: Petr

phonestring

Ejemplo: +9 999-999-99-99

latitudenumber

Ejemplo: 55.782048128903

longitudenumber

Ejemplo: 37.558031208903

timestampinteger

Ejemplo: 1707217864

ordersarray of object

idinteger

Ejemplo: 15

order_numberinteger

Ejemplo: 123456

cityobject

latitudenumberobligatorio

Ejemplo: 55.782048128903

longitudenumberobligatorio

Ejemplo: 37.558031208903

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/couriers_map_real_time', [ '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/couriers_map_real_time", { 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/couriers_map_real_time", 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": [ { "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 } } }