Pobierz kurierów na mapie

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Zwraca kurierów do mapy. Do aktywnych zamówień kuriera nie są wliczane zamówienia ze statusami not_processed, canceled i done. Zwracane są również współrzędne miasta oddziału, aby wycentrować mapę.

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 8779

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

listarray of object

idintegerwymagane

Przykład: 1

namestringwymagane

Przykład: Petr

phonestring

Przykład: +9 999-999-99-99

latitudenumber

Przykład: 55.782048128903

longitudenumber

Przykład: 37.558031208903

timestampinteger

Przykład: 1707217864

ordersarray of object

idinteger

Przykład: 15

order_numberinteger

Przykład: 123456

cityobject

latitudenumberwymagane

Przykład: 55.782048128903

longitudenumberwymagane

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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 } } }