API

Get a list of delivery services

GET/api/crm/v2/integration_courier_servicesv2
operationId: integrationCourierServices.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

settingsobject
expedited_delivery_enabledbooleanrequired

Example: true

prepayment_enabledbooleanrequired

Example: true

auto_confirm_delivery_enabledbooleanrequired

Example: true

minimum_order_amountnumberrequired

Example: 10.4

additional_cost_of_deliverynumberrequired

Example: 10.5

listarray of object
idintegerrequired

Example: 1

service_idintegerrequired

Example: 1

service_enabledbooleanrequired

Example: true

wikistring

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

fieldsarray of objectrequired
encryptedbooleanrequired

Encrypted field; use a password-type input field

Example: true

namestringrequired

Key template ${field}

Example: token

valueoneOf
One of the options
string

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

Example: secretkey

typestring

Not available for text field

Values:switch

Example: switch

sitestringrequired

Example: https://dostavka.yandex.ru/

system_namestringrequired

Example: YandexDelivery