Alterar a ordem das cidades

POST/api/crm/v2/cities_sort.sortv2

operationId: citiesSort.sort

Altera a ordem das cidades. O objeto sort mapeia city_id para a posição; o campo sort das filiais da rede nesta zona é atualizado. A posição deve ser um número: valores não numéricos são rejeitados com o erro 121, e variables.city_id indica o registro.
Erros:

117 — campo não fornecido
100 — zona desconhecida ou zona à qual as cidades não pertencem
168 — sort não é um objeto.

Autorização

api-token + language + role

Parâmetros de consulta

chain_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `application/json`

object

zonestring

Exemplo: ru

sortobjectobrigatório

Correspondência [city_id]: número_de_ordem

Valores do dicionário

integer

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: 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: pt' \
  -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' => 'pt',
        '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": "pt",
        "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": "pt",
        "role": "partner",
    },
    json={
        "zone": "ru",
        "sort": {
            "737": 1,
            "744": 0,
        },
    },
)
data = response.json()

Resposta 200

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

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Alterar a ordem das cidades

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`