Získat seznam nastavení kurýrů

GET/api/crm/v2/couriers_listv2

operationId: couriersList.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idintegerpovinné

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

settingsobject

distribution_methodstringpovinné

Hodnoty:manuallyautomatically

Příklad: manually

independencebooleanpovinné

Příklad: true

listarray of object

idintegerpovinné

Příklad: 1

namestringpovinné

Příklad: example

firm_user_idinteger

Příklad: 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: cs' \
  -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' => 'cs',
        '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": "cs",
        "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": "cs",
        "role": "partner",
    },
)
data = response.json()

Odpověď 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
        ]
      }
    ]
  }
}

Žádosti jsou odesílány na foodsoul.ru — to je hostitel tohoto portálu, jiný vybrat nelze.