Save district polygons on the map

POST/api/crm/v2/districts.map_updatev2

operationId: districts.mapUpdate

Saves district polygons. The request body contains the entire map: a district not present in districts will lose its polygons—this is how the "Delete polygons" option in the district menu works. The district color is stored in its polygons and is deleted along with them, so color is required in each item.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

object

districtsobjectrequired

Dictionary values

object

colorstringrequired

Color in HEX format without the leading "#" symbol; required: a district without shapes does not have a color to use as a fallback

Example: 82B1FF

coordinatesarray of array of array of numberrequired

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/districts.map_update?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"districts":{"55301":{"color":"82B1FF","coordinates":[[[58.621257465658,49.664283218379],[58.619290987338,49.653211059566]]]}}}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/districts.map_update?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'districts' => [
            '55301' => [
                'color' => '82B1FF',
                'coordinates' => [
                    [
                        [
                            58.621257465658,
                            49.664283218379,
                        ],
                        [
                            58.619290987338,
                            49.653211059566,
                        ],
                    ],
                ],
            ],
        ],
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/districts.map_update?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "districts": {
            "55301": {
                "color": "82B1FF",
                "coordinates": [
                    [
                        [
                            58.621257465658,
                            49.664283218379
                        ],
                        [
                            58.619290987338,
                            49.653211059566
                        ]
                    ]
                ]
            }
        }
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/districts.map_update?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "districts": {
            "55301": {
                "color": "82B1FF",
                "coordinates": [
                    [
                        [
                            58.621257465658,
                            49.664283218379,
                        ],
                        [
                            58.619290987338,
                            49.653211059566,
                        ],
                    ],
                ],
            },
        },
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {}
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.

Save district polygons on the map

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`