Obter a lista de serviços de entrega

GET/api/crm/v2/integration_courier_servicesv2

operationId: integrationCourierServices.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

settingsobject

expedited_delivery_enabledbooleanobrigatório

Exemplo: true

prepayment_enabledbooleanobrigatório

Exemplo: true

auto_confirm_delivery_enabledbooleanobrigatório

Exemplo: true

minimum_order_amountnumberobrigatório

Exemplo: 10.4

additional_cost_of_deliverynumberobrigatório

Exemplo: 10.5

listarray of object

idintegerobrigatório

Exemplo: 1

service_idintegerobrigatório

Exemplo: 1

service_enabledbooleanobrigatório

Exemplo: true

wikistring

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

fieldsarray of objectobrigatório

encryptedbooleanobrigatório

Campo criptografado; use um campo do tipo "senha" para entrada

Exemplo: true

namestringobrigatório

Modelo de chave ${field}

Exemplo: token

valueoneOf

Uma das opções

string

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

Exemplo: secretkey

typestring

Ausente em campo de texto

Valores:switch

Exemplo: switch

sitestringobrigatório

Exemplo: https://dostavka.yandex.ru/

system_namestringobrigatório

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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" } ] } }