Obter a lista de distritos de entrega com polígonos

GET/api/crm/v2/districtsv2

operationId: districts.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

settingsobject (SettingsDistricts)

branch_idinteger

Exemplo: 1

operator_idinteger

Exemplo: 1

delivery_timeintegerobrigatório

Exemplo: 60

other_delivery_timeinteger

Exemplo: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Exemplo: false

cost_of_deliverynumber

Exemplo: 100

minimum_order_amountnumber

Exemplo: 200

free_delivery_fromnumber

Exemplo: 400

paid_delivery_enabledboolean

Exemplo: false

other_minimum_order_amountnumber

Exemplo: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Exemplo: false

work_timearray of object (WorkTimePrepared) obrigatório

dayintegerobrigatório

Valores:1234567

Exemplo: 1

parameterinteger

Valores:123

Exemplo: 1

timesarray of string

redirect_district_idinteger

Exemplo: 1

timeworkstring

Exemplo: 00:00 - 23:59

cityobject

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Kaliningrad

timezonestringobrigatório

Exemplo: Europe/Kaliningrad

latitudenumberobrigatório

Exemplo: 54.710426

longitudenumberobrigatório

Exemplo: 20.452214

listarray of object

idintegerobrigatório

Exemplo: 1

old_idinteger

Exemplo: 1

namestringobrigatório

Exemplo: Central

publishedbooleanobrigatório

Exemplo: true

sortintegerobrigatório

Exemplo: -1715765994

polygonsobject

colorstringobrigatório

Cor em formato HEX sem o símbolo "#" inicial. A cor do distrito é armazenada aqui; se o distrito não tiver polígonos, não há cor e a interface seleciona uma.

Exemplo: 3949AB

coordinatesarray of array of array of numberobrigatório

operator_idinteger

Exemplo: 1

work_timearray of object (WorkTimePrepared)

dayintegerobrigatório

Valores:1234567

Exemplo: 1

parameterinteger

Valores:123

Exemplo: 1

timesarray of string

delivery_timeinteger

Exemplo: 60

other_delivery_timeinteger

Exemplo: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Exemplo: true

cost_of_deliverynumber

Exemplo: 200

minimum_order_amountnumber

Exemplo: 400

free_delivery_fromnumber

Exemplo: 400

paid_delivery_enabledboolean

Exemplo: true

other_minimum_order_amountnumber

Exemplo: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Exemplo: true

redirect_district_idinteger

Exemplo: 55315

pickup_address_idinteger

Exemplo: 4947

timeworkstring

Exemplo: 00:00 - 23:59

districts_read_onlyarray of object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Central

polygonsobject

colorstringobrigatório

Cor em formato HEX sem o símbolo "#" inicial. A cor do distrito é armazenada aqui; se o distrito não tiver polígonos, não há cor e ela é definida pela interface.

Exemplo: 3949AB

coordinatesarray of array of array of numberobrigatório

descriptionobject

countrystringobrigatório

Exemplo: Russia

chainstringobrigatório

Exemplo: Green Basket

citystringobrigatório

Exemplo: Kaliningrad

entity_namestring

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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" } } ] } }