Получить список служб доставки

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 1

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

settingsobject

expedited_delivery_enabledbooleanобязательный

Пример: true

prepayment_enabledbooleanобязательный

Пример: true

auto_confirm_delivery_enabledbooleanобязательный

Пример: true

minimum_order_amountnumberобязательный

Пример: 10.4

additional_cost_of_deliverynumberобязательный

Пример: 10.5

listarray of object

idintegerобязательный

Пример: 1

service_idintegerобязательный

Пример: 1

service_enabledbooleanобязательный

Пример: true

wikistring

Пример: https://wiki.foodsoul.pro/i/97

fieldsarray of objectобязательный

encryptedbooleanобязательный

Зашифрованное поле; для ввода используйте поле типа «пароль»

Пример: true

namestringобязательный

Шаблон ключа ${field}

Пример: token

valueoneOf

Один из вариантов

string

Текстовое поле

Пример: secretkey

typestring

Отсутствует у текстового поля

Значения:switch

Пример: switch

sitestringобязательный

Пример: https://dostavka.yandex.ru/

system_namestringобязательный

Пример: YandexDelivery

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/integration_courier_services', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

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

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "settings": { "expedited_delivery_enabled": true, "prepayment_enabled": true, "auto_confirm_delivery_enabled": true, "minimum_order_amount": 10.4, "additional_cost_of_delivery": 10.5 }, "list": [ { "id": 1, "service_id": 1, "service_enabled": true, "wiki": "https://wiki.foodsoul.pro/i/97", "fields": [ { "encrypted": true, "name": "token", "type": "switch" } ], "site": "https://dostavka.yandex.ru/", "system_name": "YandexDelivery" } ] } }