Liste der Lieferdienste abrufen

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

settingsobject

expedited_delivery_enabledbooleanerforderlich

Beispiel: true

prepayment_enabledbooleanerforderlich

Beispiel: true

auto_confirm_delivery_enabledbooleanerforderlich

Beispiel: true

minimum_order_amountnumbererforderlich

Beispiel: 10.4

additional_cost_of_deliverynumbererforderlich

Beispiel: 10.5

listarray of object

idintegererforderlich

Beispiel: 1

service_idintegererforderlich

Beispiel: 1

service_enabledbooleanerforderlich

Beispiel: true

wikistring

Beispiel: https://wiki.foodsoul.pro/i/97

fieldsarray of objecterforderlich

encryptedbooleanerforderlich

Verschlüsseltes Feld; verwenden Sie für die Eingabe ein Passwortfeld

Beispiel: true

namestringerforderlich

Schlüsselvorlage ${field}

Beispiel: token

valueoneOf

Eine der Optionen

string

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

Beispiel: secretkey

typestring

Fehlt bei einem Textfeld

Werte:switch

Beispiel: switch

sitestringerforderlich

Beispiel: https://dostavka.yandex.ru/

system_namestringerforderlich

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