sale.statusLang.list
Получить список локализаций статусов
Описание
Метод sale.statusLang.list получает список локализаций статусов заказа или доставки.
Параметры
select
array
необязательный
Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_status_lang).
Если не передан или передан пустой массив, то будут выбраны все доступные поля локализаций статусов
filter
object
необязательный
Объект для фильтрации выбранных элементов табличной части отгрузки в формате {"field_1": "value_1", ... "field_N": "value_N"}.
Возможные значения для field соответствуют полям объекта sale_status_lang.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- = — равно (работает и с массивами)
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- > — больше
- < — меньше
- != — не равно
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
- >= — больше либо равно
- <= — меньше либо равно
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения начинающиеся с «мол»
- "%мол" — ищем значения заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции
- %= — LIKE (смотрите описание выше)
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищем значения не начинающиеся с «мол»
- "%мол" — ищем значения не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (смотрите описание выше)
order
object
необязательный
Объект для сортировки выбранных статусов в формате {"field_1": "order_1", ... "field_N": "order_N"}.
Возможные значения для field соответствуют полям объекта sale_status_lang.
Возможные значения для order:
asc— в порядке возрастанияdesc— в порядке убывания
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов необходимо передавать значение 50. Чтобы выбрать третью страницу результатов значение — 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type StatusLangListResult = {
statusLangs: {
statusId: string
lid: string
name: string
description: string
}[]
}
try {
// sale.statusLang.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<StatusLangListResult>({
method: 'sale.statusLang.list',
params: {
select: ['statusId', 'lid', 'name', 'description'],
filter: {
statusId: 'N',
lid: 'ru',
},
order: {
statusId: 'asc',
},
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Status langs count:', result.statusLangs.length, result.statusLangs)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getStatusLangList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.statusLang.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'sale.statusLang.list',
params: {
select: ['statusId', 'lid', 'name', 'description'],
filter: {
statusId: 'N',
lid: 'ru',
},
order: {
statusId: 'asc',
},
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Status langs count:', result.statusLangs.length, result.statusLangs)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStatusLangList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.statuslang.list(
select=[
"statusId",
"lid",
"name",
"description",
],
filter={
"statusId": "N",
"lid": "ru",
},
order={
"statusId": "asc",
},
start='1712656146.769524',
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.statusLang.list", b24.Params{
"select": []string{"statusId", "lid", "name", "description"},
"filter": b24.Params{
"statusId": "N",
"lid": "ru",
},
"order": b24.Params{
"statusId": "asc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.statusLang.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "statusLangs".
raw, ok := b24.Unwrap(res.Result, "statusLangs")
if !ok {
return fmt.Errorf("в ответе нет ключа statusLangs")
}
var items []struct {
Description string `json:"description"`
Lid string `json:"lid"`
Name string `json:"name"`
StatusID string `json:"statusId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Description)
}
Ответ
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
object
Корневой элемент ответа
statusLangs
sale_status_lang[]
Массив объектов с информацией о выбранных локализациях статусов
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
| Код | Описание | Значение |
|---|---|---|
200040300010 |
Недостаточно прав для чтения локализаций статусов | |
0 |
Другие ошибки (например, фатальные ошибки) |

