Gauti pristatymo tarnybų sąrašą

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 1

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

settingsobject

expedited_delivery_enabledbooleanprivalomas

Pavyzdys: true

prepayment_enabledbooleanprivalomas

Pavyzdys: true

auto_confirm_delivery_enabledbooleanprivalomas

Pavyzdys: true

minimum_order_amountnumberprivalomas

Pavyzdys: 10.4

additional_cost_of_deliverynumberprivalomas

Pavyzdys: 10.5

listarray of object

idintegerprivalomas

Pavyzdys: 1

service_idintegerprivalomas

Pavyzdys: 1

service_enabledbooleanprivalomas

Pavyzdys: true

wikistring

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

fieldsarray of objectprivalomas

encryptedbooleanprivalomas

Užšifruotas laukas; įvedimui naudokite „slaptažodžio“ tipo lauką

Pavyzdys: true

namestringprivalomas

Raktinio žodžio šablonas ${field}

Pavyzdys: token

valueoneOf

Vienas iš variantų

string

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

Pavyzdys: secretkey

typestring

Nėra tekstiniame lauke

Reikšmės:switch

Pavyzdys: switch

sitestringprivalomas

Pavyzdys: https://dostavka.yandex.ru/

system_namestringprivalomas

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