Pobierz listę stref dostawy z poligonami

GET/api/crm/v2/districtsv2

operationId: districts.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 1

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

settingsobject (SettingsDistricts)

branch_idinteger

Przykład: 1

operator_idinteger

Przykład: 1

delivery_timeintegerwymagane

Przykład: 60

other_delivery_timeinteger

Przykład: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Przykład: false

cost_of_deliverynumber

Przykład: 100

minimum_order_amountnumber

Przykład: 200

free_delivery_fromnumber

Przykład: 400

paid_delivery_enabledboolean

Przykład: false

other_minimum_order_amountnumber

Przykład: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Przykład: false

work_timearray of object (WorkTimePrepared) wymagane

dayintegerwymagane

Wartości:1234567

Przykład: 1

parameterinteger

Wartości:123

Przykład: 1

timesarray of string

redirect_district_idinteger

Przykład: 1

timeworkstring

Przykład: 00:00 - 23:59

cityobject

idintegerwymagane

Przykład: 1

namestringwymagane

Przykład: Kaliningrad

timezonestringwymagane

Przykład: Europe/Kaliningrad

latitudenumberwymagane

Przykład: 54.710426

longitudenumberwymagane

Przykład: 20.452214

listarray of object

idintegerwymagane

Przykład: 1

old_idinteger

Przykład: 1

namestringwymagane

Przykład: Central

publishedbooleanwymagane

Przykład: true

sortintegerwymagane

Przykład: -1715765994

polygonsobject

colorstringwymagane

Kolor w formacie HEX bez wiodącego znaku „#”. Kolor obszaru jest przechowywany tutaj; jeśli obszar nie ma figur, nie ma koloru i jest on wybierany przez interfejs.

Przykład: 3949AB

coordinatesarray of array of array of numberwymagane

operator_idinteger

Przykład: 1

work_timearray of object (WorkTimePrepared)

dayintegerwymagane

Wartości:1234567

Przykład: 1

parameterinteger

Wartości:123

Przykład: 1

timesarray of string

delivery_timeinteger

Przykład: 60

other_delivery_timeinteger

Przykład: 90

other_delivery_time_periodsarray of string

other_delivery_time_enabledboolean

Przykład: true

cost_of_deliverynumber

Przykład: 200

minimum_order_amountnumber

Przykład: 400

free_delivery_fromnumber

Przykład: 400

paid_delivery_enabledboolean

Przykład: true

other_minimum_order_amountnumber

Przykład: 300

other_minimum_order_amount_daysarray of integer

other_minimum_order_amount_periodsarray of string

other_minimum_order_amount_enabledboolean

Przykład: true

redirect_district_idinteger

Przykład: 55315

pickup_address_idinteger

Przykład: 4947

timeworkstring

Przykład: 00:00 - 23:59

districts_read_onlyarray of object

idintegerwymagane

Przykład: 1

namestringwymagane

Przykład: Central

polygonsobject

colorstringwymagane

Kolor w formacie HEX bez wiodącego znaku „#”. Kolor obszaru jest przechowywany tutaj; jeśli obszar nie ma figur, nie ma koloru i jest on wybierany przez interfejs.

Przykład: 3949AB

coordinatesarray of array of array of numberwymagane

descriptionobject

countrystringwymagane

Przykład: Russia

chainstringwymagane

Przykład: Green Basket

citystringwymagane

Przykład: Kaliningrad

entity_namestring

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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" } } ] } }