Obține lista setărilor curierilor

GET/api/crm/v2/couriers_listv2

operationId: couriersList.default

Autorizare

api-token + language + role

Parametri de interogare

branch_idintegerobligatoriu

Exemplu: 1

Răspunsuri

object

statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

settingsobject

distribution_methodstringobligatoriu

Valori:manuallyautomatically

Exemplu: manually

independencebooleanobligatoriu

Exemplu: true

listarray of object

idintegerobligatoriu

Exemplu: 1

namestringobligatoriu

Exemplu: example

firm_user_idinteger

Exemplu: 1

districts_idsarray of integer

curl -X GET 'https://foodsoul.ru/api/crm/v2/couriers_list?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: ro' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/couriers_list?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'ro',
        'role' => 'partner',
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/couriers_list?branch_id=1", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ro",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/couriers_list?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ro",
        "role": "partner",
    },
)
data = response.json()

Răspuns 200

{
  "status": "success",
  "data": {
    "filters": {
      "branch_id": {
        "value": 8920,
        "type": "select",
        "option": [
          {
            "value": 8920,
            "name": "Green Basket | Kaliningrad"
          }
        ],
        "mode": "value_required"
      }
    },
    "settings": {
      "distribution_method": "manually",
      "independence": true
    },
    "list": [
      {
        "id": 1,
        "name": "example",
        "firm_user_id": 1,
        "districts_ids": [
          1
        ]
      }
    ]
  }
}

Solicitările sunt trimise către foodsoul.ru — acesta este gazda acestui portal, nu se poate alege alta.