Hangi piirkondade nimekirja koos polügoonidega

GET/api/crm/v2/districtsv2

operationId: districts.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idinteger

Näide: 1

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

settingsobject (SettingsDistricts)

branch_idinteger

Näide: 1

operator_idinteger

Näide: 1

delivery_timeintegerkohustuslik

Näide: 60

other_delivery_timeinteger

Näide: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Näide: false

cost_of_deliverynumber

Näide: 100

minimum_order_amountnumber

Näide: 200

free_delivery_fromnumber

Näide: 400

paid_delivery_enabledboolean

Näide: false

other_minimum_order_amountnumber

Näide: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Näide: false

work_timearray of object (WorkTimePrepared) kohustuslik

dayintegerkohustuslik

Väärtused:1234567

Näide: 1

parameterinteger

Väärtused:123

Näide: 1

timesarray of string

redirect_district_idinteger

Näide: 1

timeworkstring

Näide: 00:00 - 23:59

cityobject

idintegerkohustuslik

Näide: 1

namestringkohustuslik

Näide: Kaliningrad

timezonestringkohustuslik

Näide: Europe/Kaliningrad

latitudenumberkohustuslik

Näide: 54.710426

longitudenumberkohustuslik

Näide: 20.452214

listarray of object

idintegerkohustuslik

Näide: 1

old_idinteger

Näide: 1

namestringkohustuslik

Näide: Central

publishedbooleankohustuslik

Näide: true

sortintegerkohustuslik

Näide: -1715765994

polygonsobject

colorstringkohustuslik

Värv HEX-formaadis ilma algava sümbolita „#“. Piirkonna värv salvestatakse siia; kui piirkonnal pole kujundeid, pole ka värvi ning selle valib liides.

Näide: 3949AB

coordinatesarray of array of array of numberkohustuslik

operator_idinteger

Näide: 1

work_timearray of object (WorkTimePrepared)

dayintegerkohustuslik

Väärtused:1234567

Näide: 1

parameterinteger

Väärtused:123

Näide: 1

timesarray of string

delivery_timeinteger

Näide: 60

other_delivery_timeinteger

Näide: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Näide: true

cost_of_deliverynumber

Näide: 200

minimum_order_amountnumber

Näide: 400

free_delivery_fromnumber

Näide: 400

paid_delivery_enabledboolean

Näide: true

other_minimum_order_amountnumber

Näide: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Näide: true

redirect_district_idinteger

Näide: 55315

pickup_address_idinteger

Näide: 4947

timeworkstring

Näide: 00:00 - 23:59

districts_read_onlyarray of object

idintegerkohustuslik

Näide: 1

namestringkohustuslik

Näide: Central

polygonsobject

colorstringkohustuslik

Värv HEX-formaadis ilma juhtiva sümbolita „#“. Piirkonna värv salvestatakse siia; kui piirkonnal pole kujundeid, pole ka värvi ning selle valib liides.

Näide: 3949AB

coordinatesarray of array of array of numberkohustuslik

descriptionobject

countrystringkohustuslik

Näide: Russia

chainstringkohustuslik

Näide: Green Basket

citystringkohustuslik

Näide: Kaliningrad

entity_namestring

Näide: LLC Green Basket

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/districts', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'et', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/districts", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "et", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/districts", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "et", "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" } }, "settings": { "branch_id": 1, "operator_id": 1, "delivery_time": 60, "other_delivery_time": 90, "other_delivery_time_periods": [ "00:00 - 23:59" ], "other_delivery_time_enabled": false, "cost_of_delivery": 100, "minimum_order_amount": 200, "free_delivery_from": 400, "paid_delivery_enabled": false, "other_minimum_order_amount": 300, "other_minimum_order_amount_days": [ 1 ], "other_minimum_order_amount_periods": [ "00:00 - 23:59" ], "other_minimum_order_amount_enabled": false, "work_time": [ { "day": 1, "parameter": 1, "times": [ "00:00 - 23:59" ] } ], "redirect_district_id": 1, "timework": "00:00 - 23:59" }, "city": { "id": 1, "name": "Kaliningrad", "timezone": "Europe/Kaliningrad", "latitude": 54.710426, "longitude": 20.452214 }, "list": [ { "id": 1, "old_id": 1, "name": "Central", "published": true, "sort": -1715765994, "polygons": { "color": "3949AB", "coordinates": [ [ [ 58.621257465658, 49.664283218379 ], [ 58.619290987338, 49.653211059566 ], [ 58.613212081974, 49.644113006587 ] ] ] }, "operator_id": 1, "work_time": [ { "day": 1, "parameter": 1, "times": [] } ], "delivery_time": 60, "other_delivery_time": 90, "other_delivery_time_periods": [ "00:00 - 23:59" ], "other_delivery_time_enabled": true, "cost_of_delivery": 200, "minimum_order_amount": 400, "free_delivery_from": 400, "paid_delivery_enabled": true, "other_minimum_order_amount": 300, "other_minimum_order_amount_days": [ 1, 2, 3, 4, 5 ], "other_minimum_order_amount_periods": [ "00:00 - 23:59" ], "other_minimum_order_amount_enabled": true, "redirect_district_id": 55315, "pickup_address_id": 4947, "timework": "00:00 - 23:59" } ], "districts_read_only": [ { "id": 1, "name": "Central", "polygons": { "color": "3949AB", "coordinates": [ [ [ 58.621257465658, 49.664283218379 ], [ 58.619290987338, 49.653211059566 ], [ 58.613212081974, 49.644113006587 ] ] ] }, "description": { "country": "Russia", "chain": "Green Basket", "city": "Kaliningrad", "entity_name": "LLC Green Basket" } } ] } }