Get a list of localizations for sale.statusLang.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
The method sale.statusLang.list retrieves a list of localizations for order or delivery statuses.
Method Parameters
|
Name |
Description |
|
select |
An array containing the list of fields to select (see fields of the sale_status_lang object). If not provided or an empty array is passed, all available fields of status localizations will be selected. |
|
filter |
An object for filtering the selected items in the shipment table part in the format Possible values for An additional prefix can be assigned to the key to clarify the filter's behavior. Possible prefix values:
|
|
order |
An object for sorting the selected statuses in the format Possible values for Possible values for order:
|
|
start |
This parameter is used for managing pagination. The page size of results is always static: 50 records. To select the second page of results, you need to pass the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["statusId","lid","name","description"],"filter":{"statusId":"N","lid":"de"},"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":"de"},"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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'sale.statusLang.list',
[
'select' => [
'statusId',
'lid',
'name',
'description',
],
'filter' => [
'statusId' => 'N',
'lid' => 'de',
],
'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": "de",
},
"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' => 'de',
],
'order' => [
'statusId' => 'asc',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "statusLangs" key.
raw, ok := b24.Unwrap(res.Result, "statusLangs")
if !ok {
return fmt.Errorf("no statusLangs key in the response")
}
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("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.Description)
}
Response Handling
HTTP status: 200
{
"result": {
"statusLangs": [
{
"description": "Order accepted, but not yet processed (for example, the order has just been created or payment is awaited)",
"lid": "de",
"name": "Accepted, awaiting payment",
"statusId": "N"
}
]
},
"total": 1,
"time": {
"start": 1712656146.769524,
"finish": 1712656146.98067,
"duration": 0.21114587783813477,
"processing": 0.02018594741821289,
"date_start": "2024-04-09T12:49:06+02:00",
"date_finish": "2024-04-09T12:49:06+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response |
|
statusLangs |
An array of objects with information about the selected status localizations |
|
total |
The total number of records found |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": 0,
"error_description": "error"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient rights to read status localizations |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Localization of Order and Delivery Statuses in Online Stores: Overview of Methods
- Get the list of languages for localization sale.statusLang.getListLangs
- Add Localization sale.statusLang.add
- Delete localization sale.statusLang.deleteByFilter
- Get Localization Fields for Statuses sale.statusLang.getFields