Ottenere i corrieri sulla mappa

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Restituisce i corrieri per la mappa. Gli ordini nei seguenti stati non sono considerati attivi per il corriere: not_processed, canceled e done. Vengono inoltre restituite le coordinate della città della filiale per centrare la mappa.

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 8779

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

listarray of object

idintegerobbligatorio

Esempio: 1

namestringobbligatorio

Esempio: Petr

phonestring

Esempio: +9 999-999-99-99

latitudenumber

Esempio: 55.782048128903

longitudenumber

Esempio: 37.558031208903

timestampinteger

Esempio: 1707217864

ordersarray of object

idinteger

Esempio: 15

order_numberinteger

Esempio: 123456

cityobject

latitudenumberobbligatorio

Esempio: 55.782048128903

longitudenumberobbligatorio

Esempio: 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' => 'it', '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": "it", "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": "it", "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 } } }