Pobierz listę usług kurierskich

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 1

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

settingsobject

expedited_delivery_enabledbooleanwymagane

Przykład: true

prepayment_enabledbooleanwymagane

Przykład: true

auto_confirm_delivery_enabledbooleanwymagane

Przykład: true

minimum_order_amountnumberwymagane

Przykład: 10.4

additional_cost_of_deliverynumberwymagane

Przykład: 10.5

listarray of object

idintegerwymagane

Przykład: 1

service_idintegerwymagane

Przykład: 1

service_enabledbooleanwymagane

Przykład: true

wikistring

Przykład: https://wiki.foodsoul.pro/i/97

fieldsarray of objectwymagane

encryptedbooleanwymagane

Zaszyfrowane pole; do wprowadzania użyj pola typu „hasło”

Przykład: true

namestringwymagane

Szablon klucza ${field}

Przykład: token

valueoneOf

Jeden z wariantów

string

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

Przykład: secretkey

typestring

Brak dla pola tekstowego

Wartości:switch

Przykład: switch

sitestringwymagane

Przykład: https://dostavka.yandex.ru/

system_namestringwymagane

Przykład: YandexDelivery

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/integration_courier_services", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pl", "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" } ] } }