Gauti kurjerius žemėlapyje

GET/api/crm/v2/couriers_map_real_timev2

operationId: couriersMapRealTime.default

Grąžina kurjerius žemėlapiui. Į aktyvius kurjerio užsakymus neįtraukiami užsakymai su statusais not_processed, canceled ir done. Taip pat grąžinamos filialo miesto koordinatės, kad būtų galima centruoti žemėlapį.

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 8779

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

listarray of object

idintegerprivalomas

Pavyzdys: 1

namestringprivalomas

Pavyzdys: Petr

phonestring

Pavyzdys: +9 999-999-99-99

latitudenumber

Pavyzdys: 55.782048128903

longitudenumber

Pavyzdys: 37.558031208903

timestampinteger

Pavyzdys: 1707217864

ordersarray of object

idinteger

Pavyzdys: 15

order_numberinteger

Pavyzdys: 123456

cityobject

latitudenumberprivalomas

Pavyzdys: 55.782048128903

longitudenumberprivalomas

Pavyzdys: 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' => 'lt', '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": "lt", "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": "lt", "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 } } }