Get city order

GET/api/crm/v2/cities_sortv2

operationId: citiesSort.default

Returns the network's cities grouped by zones, with current sorting values. For a child network, parent_chain_id returns the parent network ID.

Authorization

api-token + language + role

Query parameters

chain_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

listarray of object

zonestringrequired

Example: ru

citiesarray of objectrequired

sortintegerrequired

Example: 0

idintegerrequired

Example: 1

namestringrequired

Example: Kirov

parent_chain_idinteger

Example: 7134

parent_zonestring

Example: ru

curl -X GET 'https://foodsoul.pro/api/crm/v2/cities_sort' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/cities_sort', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/cities_sort", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/cities_sort",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {
    "filters": {},
    "list": [
      {
        "zone": "ru",
        "cities": [
          {
            "sort": 0,
            "id": 1,
            "name": "Kirov"
          }
        ]
      }
    ],
    "parent_chain_id": 7134,
    "parent_zone": "ru"
  }
}

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