Получить список локализаций статусов sale.statusLang.list
Scope:
saleКто может выполнять метод: администратор
Метод получает список локализаций статусов заказа или доставки.
Параметры метода
|
Название |
Описание |
|
select |
Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_status_lang). Если не передан или передан пустой массив, то будут выбраны все доступные поля локализаций статусов |
|
filter |
Объект для фильтрации выбранных элементов табличной части отгрузки в формате Возможные значения для Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных статусов в формате Возможные значения для Возможные значения для order:
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["statusId","lid","name","description"],"filter":{"statusId":"N","lid":"ru"},"order":{"statusId":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.statuslang.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["statusId","lid","name","description"],"filter":{"statusId":"N","lid":"ru"},"order":{"statusId":"asc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.statuslang.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'sale.statuslang.list',
{
"select": [
"statusId",
"lid",
"name",
"description",
],
"filter": {
"statusId": "N",
"lid": "ru",
},
"order": {
"statusId": "asc",
}
},
(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.statuslang.list', {
"select": [
"statusId",
"lid",
"name",
"description",
],
"filter": {
"statusId": "N",
"lid": "ru",
},
"order": {
"statusId": "asc",
}
}, '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.statuslang.list', {
"select": [
"statusId",
"lid",
"name",
"description",
],
"filter": {
"statusId": "N",
"lid": "ru",
},
"order": {
"statusId": "asc",
}
}, 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.statuslang.list',
[
'select' => [
'statusId',
'lid',
'name',
'description',
],
'filter' => [
'statusId' => 'N',
'lid' => 'ru',
],
'order' => [
'statusId' => 'asc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching sale status languages: ' . $e->getMessage();
}
BX24.callMethod(
"sale.statuslang.list", {
"select": [
"statusId",
"lid",
"name",
"description",
],
"filter": {
"statusId": "N",
"lid": "ru",
},
"order": {
"statusId": "asc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.statuslang.list',
[
'select' => [
'statusId',
'lid',
'name',
'description',
],
'filter' => [
'statusId' => 'N',
'lid' => 'ru',
],
'order' => [
'statusId' => 'asc',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result":{
"statusLangs":[
{
"description":"Заказ принят, но пока не обрабатывается (например, заказ только что создан или ожидается оплата заказа)",
"lid":"ru",
"name":"Принят, ожидается оплата",
"statusId":"N"
}
]
},
"total":1,
"time":{
"start":1712656146.769524,
"finish":1712656146.98067,
"duration":0.21114587783813477,
"processing":0.02018594741821289,
"date_start":"2024-04-09T12:49:06+03:00",
"date_finish":"2024-04-09T12:49:06+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
statusLangs |
Массив объектов с информацией о выбранных локализациях статусов |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения локализаций статусов |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Локализация статусов заказа и доставки в Интернет-магазине: обзор методов
- Получить список языков для локализации sale.statusLang.getListLangs
- Добавить локализацию sale.statusLang.add
- Удалить локализацию sale.statusLang.deleteByFilter
- Получить поля локализации статусов sale.statusLang.getFields