Pobierz listę ustawień kurierów

GET/api/crm/v2/couriers_listv2

operationId: couriersList.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idintegerwymagane

Przykład: 1

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

settingsobject

distribution_methodstringwymagane

Wartości:manuallyautomatically

Przykład: manually

independencebooleanwymagane

Przykład: true

listarray of object

idintegerwymagane

Przykład: 1

namestringwymagane

Przykład: example

firm_user_idinteger

Przykład: 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: pl' \
  -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' => 'pl',
        '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": "pl",
        "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": "pl",
        "role": "partner",
    },
)
data = response.json()

Odpowiedź 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
        ]
      }
    ]
  }
}

Żądania są wysyłane na foodsoul.ru — to jest host tego portalu, nie można wybrać innego.