Change city order

POST/api/crm/v2/cities_sort.sortv2

operationId: citiesSort.sort

Changes the order of cities. The sort object maps city_id to position; the sort field of network branches in this area is updated. Position must be a number: non-numeric values are rejected with error 121, and variables.city_id refers to the record.
Errors:

117 — missing field
100 — unknown area or area not related to the cities
168 — sort is not an object.

Authorization

api-token + language + role

Query parameters

chain_idintegerrequired

Example: 1

Request body `application/json`

object

zonestring

Example: ru

sortobjectrequired

Mapping [city_id]: sort_number

Dictionary values

integer

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/cities_sort.sort?chain_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"zone":"ru","sort":{"737":1,"744":0}}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.ru/api/crm/v2/cities_sort.sort?chain_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'zone' => 'ru',
        'sort' => [
            '737' => 1,
            '744' => 0,
        ],
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/cities_sort.sort?chain_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "zone": "ru",
        "sort": {
            "737": 1,
            "744": 0
        }
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.ru/api/crm/v2/cities_sort.sort?chain_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "zone": "ru",
        "sort": {
            "737": 1,
            "744": 0,
        },
    },
)
data = response.json()

Response 200

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

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

Change city order

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`