Saņemt piegādes dienestu sarakstu

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

settingsobject

expedited_delivery_enabledbooleanobligāts

Piemērs: true

prepayment_enabledbooleanobligāts

Piemērs: true

auto_confirm_delivery_enabledbooleanobligāts

Piemērs: true

minimum_order_amountnumberobligāts

Piemērs: 10.4

additional_cost_of_deliverynumberobligāts

Piemērs: 10.5

listarray of object

idintegerobligāts

Piemērs: 1

service_idintegerobligāts

Piemērs: 1

service_enabledbooleanobligāts

Piemērs: true

wikistring

Piemērs: https://wiki.foodsoul.pro/i/97

fieldsarray of objectobligāts

encryptedbooleanobligāts

Šifrēts lauks; ievadei izmantojiet lauku ar tipu "parole"

Piemērs: true

namestringobligāts

Atslēgas veidne ${field}

Piemērs: token

valueoneOf

Viens no variantiem

string

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

Piemērs: secretkey

typestring

Nav tekstuālajam laukam

Vērtības:switch

Piemērs: switch

sitestringobligāts

Piemērs: https://dostavka.yandex.ru/

system_namestringobligāts

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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" } ] } }