Modifier l'ordre des villes

POST/api/crm/v2/cities_sort.sortv2

operationId: citiesSort.sort

Modifie l'ordre des villes. L'objet sort associe chaque city_id à une position ; le champ sort des succursales du réseau dans cette zone est mis à jour. La position doit être un nombre : une valeur non numérique est rejetée avec l'erreur 121, et variables.city_id indique l'enregistrement.
Erreurs :

117 — champ manquant,
100 — zone inconnue ou zone à laquelle les villes n'appartiennent pas,
168 — sort n'est pas un objet.

Autorisation

api-token + language + role

Paramètres de requête

chain_idintegerobligatoire

Exemple: 1

Corps de la requête `application/json`

object

zonestring

Exemple: ru

sortobjectobligatoire

Correspondance [city_id] : numéro_de_tri

Valeurs du dictionnaire

integer

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/cities_sort.sort?chain_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -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.pro/api/crm/v2/cities_sort.sort?chain_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'fr',
        'role' => 'partner',
    ],
    'json' => [
        'zone' => 'ru',
        'sort' => [
            '737' => 1,
            '744' => 0,
        ],
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/cities_sort.sort?chain_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "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.pro/api/crm/v2/cities_sort.sort?chain_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
    },
    json={
        "zone": "ru",
        "sort": {
            "737": 1,
            "744": 0,
        },
    },
)
data = response.json()

Réponse 200

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

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.

Modifier l'ordre des villes

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`