Get delivery service directories

GET/api/crm/v2/integration_courier_services.fieldsv2

operationId: integrationCourierServices.fields

Returns supported delivery services: connection fields, encryptable fields, field types, and a link to the service website. The switch field type is optional: it is always passed as a boolean value.

Authorization

api-token + language + role

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

servicesarray of object

idintegerrequired

Example: 1

namestringrequired

Example: Yandex Delivery

system_namestringrequired

Example: YandexDelivery

fieldsarray of stringrequired

fields_for_cryptarray of stringrequired

fields_typesobject

Field type by its name; a field without a record is text

Dictionary values

object

typestringrequired

Values:switch

sitestringrequired

Example: https://dostavka.yandex.ru/

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

<?php

$client = new \GuzzleHttp\Client();

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

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

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

import requests

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

Response 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/"
      }
    ]
  }
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.