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

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' => 'uk', '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": "uk", "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": "uk", "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" } ] } }