Получить список обработчиков служб доставки sale.delivery.handler.list
Scope:
saleКто может выполнять метод: администратор CRM
Метод получает список обработчиков служб доставки.
Без параметров.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","PARENT_ID","NAME","ACTIVE","DESCRIPTION","SORT","LOGOTIP","CURRENCY"],"FILTER":{"@ID":[196,197,198]},"ORDER":{"SORT":"ASC","ID":"DESC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.getlist
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"SELECT":["ID","PARENT_ID","NAME","ACTIVE","DESCRIPTION","SORT","LOGOTIP","CURRENCY"],"FILTER":{"@ID":[196,197,198]},"ORDER":{"SORT":"ASC","ID":"DESC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.delivery.getlist
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'sale.delivery.handler.list',
{},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('sale.delivery.handler.list', {}, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('sale.delivery.handler.list', {}, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'sale.delivery.handler.list',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching delivery handlers: ' . $e->getMessage();
}
BX24.callMethod(
'sale.delivery.handler.list', {},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.delivery.getlist',
[
'SELECT' => [
"ID",
"PARENT_ID",
"NAME",
"ACTIVE",
"DESCRIPTION",
"SORT",
"LOGOTIP",
"CURRENCY",
],
'FILTER' => [
"@ID" => [196, 197, 198],
],
'ORDER' => [
"SORT" => "ASC",
"ID" => "DESC",
]
]
);
Обработка ответа
HTTP-статус: 200
{
"result":[
{
"ID":"14",
"NAME":"Uber",
"CODE":"uber",
"SORT":"250",
"DESCRIPTION":"Uber Description",
"SETTINGS":{
"CALCULATE_URL":"http:\/\/gateway.bx\/calculate.php",
"CREATE_DELIVERY_REQUEST_URL":"http:\/\/gateway.bx\/create_delivery_request.php",
"CANCEL_DELIVERY_REQUEST_URL":"http:\/\/gateway.bx\/cancel_delivery_request.php",
"HAS_CALLBACK_TRACKING_SUPPORT":"Y",
"CONFIG":[
{
"TYPE":"STRING",
"NAME":"String Example",
"CODE":"SETTING_1"
},
{
"TYPE":"Y\/N",
"NAME":"Checkbox Example",
"CODE":"SETTING_2"
},
{
"TYPE":"NUMBER",
"NAME":"Number Example",
"CODE":"SETTING_3"
},
{
"TYPE":"ENUM",
"NAME":"Enum Example",
"OPTIONS":{
"Option1Code":"Option1Value",
"Option2Code":"Option2Value",
"Option3Code":"Option3Value",
"Option4Code":"Option4Value",
"Option5Code":"Option5Value"
},
"CODE":"SETTING_4"
},
{
"TYPE":"DATE",
"NAME":"Date Example",
"CODE":"SETTING_5"
},
{
"TYPE":"LOCATION",
"NAME":"Location Example",
"CODE":"SETTING_6"
}
]
},
"PROFILES":[
{
"NAME":"Taxi",
"DESCRIPTION":"Taxi Delivery",
"CODE":"TAXI"
},
{
"NAME":"Cargo",
"DESCRIPTION":"Cargo Delivery",
"CODE":"CARGO"
}
]
}
],
"time":{
"start":1713872315.334967,
"finish":1713872315.655173,
"duration":0.3202061653137207,
"processing":0.013887882232666016,
"date_start":"2024-04-23T14:38:35+03:00",
"date_finish":"2024-04-23T14:38:35+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Массив объектов с информацией о выбранных обработчиках служб доставки |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400, 403
{
"error":"ACCESS_DENIED",
"error_description":"Access denied!"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Статус |
|
|
Недостаточно прав для получения списка служб доставки |
403 |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить обработчик службы доставки sale.delivery.handler.add
- Удалить обработчик службы доставки sale.delivery.handler.delete
- Обновить обработчик службы доставки sale.delivery.handler.update