Отримати довідники служб доставки

GET/api/crm/v2/integration_courier_services.fieldsv2

operationId: integrationCourierServices.fields

Повертає підтримувані служби доставки: поля підключення, поля для шифрування, типи полів і посилання на сайт служби. Поле типу switch не є обов’язковим: воно завжди передається як логічне значення.

Авторизація

api-token + language + role

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

servicesarray of object

idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: Yandex Delivery

system_namestringобов’язковий

Приклад: YandexDelivery

fieldsarray of stringобов’язковий

fields_for_cryptarray of stringобов’язковий

fields_typesobject

Тип поля за його ім'ям; поле без запису — текстове

Значення словника

object

typestringобов’язковий

Значення:switch

sitestringобов’язковий

Приклад: https://dostavka.yandex.ru/

curl -X GET 'https://foodsoul.ru/api/crm/v2/integration_courier_services.fields' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: uk' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/integration_courier_services.fields', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'uk',
        'role' => 'partner',
    ],
]);

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/integration_courier_services.fields", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/integration_courier_services.fields",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner",
    },
)
data = response.json()

Відповідь 200

{
  "status": "success",
  "data": {
    "services": [
      {
        "id": 1,
        "name": "Yandex Delivery",
        "system_name": "YandexDelivery",
        "fields": [
          "token"
        ],
        "fields_for_crypt": [
          "token"
        ],
        "fields_types": {
          "tariff_superexpress_enabled": {
            "type": "switch"
          }
        },
        "site": "https://dostavka.yandex.ru/"
      }
    ]
  }
}

Запити надсилаються на foodsoul.ru — це хост цього порталу, інший обрати неможливо.