Obtener la lista de servicios de entrega

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

settingsobject

expedited_delivery_enabledbooleanobligatorio

Ejemplo: true

prepayment_enabledbooleanobligatorio

Ejemplo: true

auto_confirm_delivery_enabledbooleanobligatorio

Ejemplo: true

minimum_order_amountnumberobligatorio

Ejemplo: 10.4

additional_cost_of_deliverynumberobligatorio

Ejemplo: 10.5

listarray of object

idintegerobligatorio

Ejemplo: 1

service_idintegerobligatorio

Ejemplo: 1

service_enabledbooleanobligatorio

Ejemplo: true

wikistring

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

fieldsarray of objectobligatorio

encryptedbooleanobligatorio

Campo cifrado; utilice un campo de tipo "contraseña" para la entrada

Ejemplo: true

namestringobligatorio

Plantilla de clave ${field}

Ejemplo: token

valueoneOf

Una de las opciones

string

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

Ejemplo: secretkey

typestring

No disponible para el campo de texto

Valores:switch

Ejemplo: switch

sitestringobligatorio

Ejemplo: https://dostavka.yandex.ru/

system_namestringobligatorio

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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" } ] } }