Ottenere l'elenco dei servizi di consegna

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

settingsobject

expedited_delivery_enabledbooleanobbligatorio

Esempio: true

prepayment_enabledbooleanobbligatorio

Esempio: true

auto_confirm_delivery_enabledbooleanobbligatorio

Esempio: true

minimum_order_amountnumberobbligatorio

Esempio: 10.4

additional_cost_of_deliverynumberobbligatorio

Esempio: 10.5

listarray of object

idintegerobbligatorio

Esempio: 1

service_idintegerobbligatorio

Esempio: 1

service_enabledbooleanobbligatorio

Esempio: true

wikistring

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

fieldsarray of objectobbligatorio

encryptedbooleanobbligatorio

Campo crittografato; per l'inserimento utilizzare un campo di tipo "password"

Esempio: true

namestringobbligatorio

Modello di chiave ${field}

Esempio: token

valueoneOf

Una delle opzioni

string

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

Esempio: secretkey

typestring

Non presente per il campo di testo

Valori:switch

Esempio: switch

sitestringobbligatorio

Esempio: https://dostavka.yandex.ru/

system_namestringobbligatorio

Esempio: 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' => 'it', '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": "it", "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": "it", "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" } ] } }