Získat seznam doručovacích služeb

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

settingsobject

expedited_delivery_enabledbooleanpovinné

Příklad: true

prepayment_enabledbooleanpovinné

Příklad: true

auto_confirm_delivery_enabledbooleanpovinné

Příklad: true

minimum_order_amountnumberpovinné

Příklad: 10.4

additional_cost_of_deliverynumberpovinné

Příklad: 10.5

listarray of object

idintegerpovinné

Příklad: 1

service_idintegerpovinné

Příklad: 1

service_enabledbooleanpovinné

Příklad: true

wikistring

Příklad: https://wiki.foodsoul.pro/i/97

fieldsarray of objectpovinné

encryptedbooleanpovinné

Šifrované pole; pro zadání použijte pole typu „heslo“

Příklad: true

namestringpovinné

Šablona klíče ${field}

Příklad: token

valueoneOf

Jedna z možností

string

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

Příklad: secretkey

typestring

Chybí u textového pole

Hodnoty:switch

Příklad: switch

sitestringpovinné

Příklad: https://dostavka.yandex.ru/

system_namestringpovinné

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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" } ] } }