Obtenir la liste des zones de livraison avec polygones

GET/api/crm/v2/districtsv2

operationId: districts.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

settingsobject (SettingsDistricts)

branch_idinteger

Exemple: 1

operator_idinteger

Exemple: 1

delivery_timeintegerobligatoire

Exemple: 60

other_delivery_timeinteger

Exemple: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Exemple: false

cost_of_deliverynumber

Exemple: 100

minimum_order_amountnumber

Exemple: 200

free_delivery_fromnumber

Exemple: 400

paid_delivery_enabledboolean

Exemple: false

other_minimum_order_amountnumber

Exemple: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Exemple: false

work_timearray of object (WorkTimePrepared) obligatoire

dayintegerobligatoire

Valeurs:1234567

Exemple: 1

parameterinteger

Valeurs:123

Exemple: 1

timesarray of string

redirect_district_idinteger

Exemple: 1

timeworkstring

Exemple: 00:00 - 23:59

cityobject

idintegerobligatoire

Exemple: 1

namestringobligatoire

Exemple: Kaliningrad

timezonestringobligatoire

Exemple: Europe/Kaliningrad

latitudenumberobligatoire

Exemple: 54.710426

longitudenumberobligatoire

Exemple: 20.452214

listarray of object

idintegerobligatoire

Exemple: 1

old_idinteger

Exemple: 1

namestringobligatoire

Exemple: Central

publishedbooleanobligatoire

Exemple: true

sortintegerobligatoire

Exemple: -1715765994

polygonsobject

colorstringobligatoire

Couleur au format HEX sans le symbole «#» initial. La couleur du district est stockée ici ; si le district n’a pas de polygones, il n’a pas de couleur et l’interface la choisit.

Exemple: 3949AB

coordinatesarray of array of array of numberobligatoire

operator_idinteger

Exemple: 1

work_timearray of object (WorkTimePrepared)

dayintegerobligatoire

Valeurs:1234567

Exemple: 1

parameterinteger

Valeurs:123

Exemple: 1

timesarray of string

delivery_timeinteger

Exemple: 60

other_delivery_timeinteger

Exemple: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Exemple: true

cost_of_deliverynumber

Exemple: 200

minimum_order_amountnumber

Exemple: 400

free_delivery_fromnumber

Exemple: 400

paid_delivery_enabledboolean

Exemple: true

other_minimum_order_amountnumber

Exemple: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Exemple: true

redirect_district_idinteger

Exemple: 55315

pickup_address_idinteger

Exemple: 4947

timeworkstring

Exemple: 00:00 - 23:59

districts_read_onlyarray of object

idintegerobligatoire

Exemple: 1

namestringobligatoire

Exemple: Central

polygonsobject

colorstringobligatoire

Couleur au format HEX sans le symbole «#» initial. La couleur du district est stockée ici ; si le district n’a pas de polygones, il n’a pas de couleur et l’interface la choisit.

Exemple: 3949AB

coordinatesarray of array of array of numberobligatoire

descriptionobject

countrystringobligatoire

Exemple: Russia

chainstringobligatoire

Exemple: Green Basket

citystringobligatoire

Exemple: Kaliningrad

entity_namestring

Exemple: 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' => 'fr', '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": "fr", "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": "fr", "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" } } ] } }