Get a list of delivery districts with polygons

GET/api/crm/v2/districtsv2

operationId: districts.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

settingsobject (SettingsDistricts)

branch_idinteger

Example: 1

operator_idinteger

Example: 1

delivery_timeintegerrequired

Example: 60

other_delivery_timeinteger

Example: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Example: false

cost_of_deliverynumber

Example: 100

minimum_order_amountnumber

Example: 200

free_delivery_fromnumber

Example: 400

paid_delivery_enabledboolean

Example: false

other_minimum_order_amountnumber

Example: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Example: false

work_timearray of object (WorkTimePrepared) required

dayintegerrequired

Values:1234567

Example: 1

parameterinteger

Values:123

Example: 1

timesarray of string

redirect_district_idinteger

Example: 1

timeworkstring

Example: 00:00 - 23:59

cityobject

idintegerrequired

Example: 1

namestringrequired

Example: Kaliningrad

timezonestringrequired

Example: Europe/Kaliningrad

latitudenumberrequired

Example: 54.710426

longitudenumberrequired

Example: 20.452214

listarray of object

idintegerrequired

Example: 1

old_idinteger

Example: 1

namestringrequired

Example: Central

publishedbooleanrequired

Example: true

sortintegerrequired

Example: -1715765994

polygonsobject

colorstringrequired

Color in HEX format without the leading "#" symbol. The district color is stored here; if a district has no shapes, it has no color, and the interface selects it.

Example: 3949AB

coordinatesarray of array of array of numberrequired

operator_idinteger

Example: 1

work_timearray of object (WorkTimePrepared)

dayintegerrequired

Values:1234567

Example: 1

parameterinteger

Values:123

Example: 1

timesarray of string

delivery_timeinteger

Example: 60

other_delivery_timeinteger

Example: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Example: true

cost_of_deliverynumber

Example: 200

minimum_order_amountnumber

Example: 400

free_delivery_fromnumber

Example: 400

paid_delivery_enabledboolean

Example: true

other_minimum_order_amountnumber

Example: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Example: true

redirect_district_idinteger

Example: 55315

pickup_address_idinteger

Example: 4947

timeworkstring

Example: 00:00 - 23:59

districts_read_onlyarray of object

idintegerrequired

Example: 1

namestringrequired

Example: Central

polygonsobject

colorstringrequired

Color in HEX format without the leading "#" symbol. The district color is stored here; if a district has no polygons, it has no color, and the interface selects it.

Example: 3949AB

coordinatesarray of array of array of numberrequired

descriptionobject

countrystringrequired

Example: Russia

chainstringrequired

Example: Green Basket

citystringrequired

Example: Kaliningrad

entity_namestring

Example: 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' => 'en', '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": "en", "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": "en", "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" } } ] } }