Kuriere auf der Karte abrufen

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Gibt die Kuriere für die Karte zurück. In die aktiven Bestellungen des Kuriers werden Bestellungen mit den Status not_processed, canceled und done nicht einbezogen. Außerdem werden die Koordinaten der Stadt der Filiale zurückgegeben, um die Karte zu zentrieren.

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 8779

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

listarray of object

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: Petr

phonestring

Beispiel: +9 999-999-99-99

latitudenumber

Beispiel: 55.782048128903

longitudenumber

Beispiel: 37.558031208903

timestampinteger

Beispiel: 1707217864

ordersarray of object

idinteger

Beispiel: 15

order_numberinteger

Beispiel: 123456

cityobject

latitudenumbererforderlich

Beispiel: 55.782048128903

longitudenumbererforderlich

Beispiel: 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' => 'de', '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": "de", "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": "de", "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 } } }