sale.statusLang.add
Добавить локализацию
Описание
Метод sale.statusLang.add добавляет локализацию статуса заказа или доставки.
Параметры
fields
object
обязательный
Значения полей (подробное описание приведено ниже) для добавления локализации статуса в виде структуры:
fields: {
statusId: 'значение',
lid: 'значение',
name: 'значение',
description: 'значение'
}Параметр fields
statusId
sale_status.id
обязательный
Символьный идентификатор статуса
lid
sale_lang.lid
обязательный
Идентификатор языка. Текущие возможные значения приведены ниже:
- ar — арабский
- br — португальский
- de — немецкий
- en — английский
- fr — французский
- hi — хинди
- id — индонезийский
- in — английский (Индия)
- it — итальянский
- ja — японский
- la — испанский
- ms — малайский
- pl — польский
- ru — русский
- sc — китайский (упрощенный)
- tc — китайский (традиционный)
- th — тайский
- tr — турецкий
- ua — украинский
- vn — вьетнамский
Список актуальных языков можно получить методом sale.statusLang.getListLangs
name
string
обязательный
Название статуса для создаваемой локализации
description
string
необязательный
Описание статуса для создаваемой локализации
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"statusId":"RD","lid":"ru","name":"Возвращен покупателем","description":"Покупатель вернул товар по причине наличия дефекта"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.statusLang.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"statusId":"RD","lid":"ru","name":"Возвращен покупателем","description":"Покупатель вернул товар по причине наличия дефекта"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.statusLang.add
// 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 StatusLangAddResult = {
statusLang: {
description: string
lid: string
name: string
statusId: string
}
}
try {
const response = await $b24.actions.v2.call.make<StatusLangAddResult>({
method: 'sale.statusLang.add',
params: {
fields: {
statusId: 'RD',
lid: 'ru',
name: 'Returned by buyer',
description: 'Buyer returned the item due to a defect',
},
},
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(result.statusLang)
}
} 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 addStatusLang() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.statusLang.add',
params: {
fields: {
statusId: 'RD',
lid: 'ru',
name: 'Returned by buyer',
description: 'Buyer returned the item due to a defect',
},
},
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(result.statusLang)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addStatusLang)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"statusId": "RD",
"lid": "ru",
"name": "Возвращен покупателем",
"description": "Покупатель вернул товар по причине наличия дефекта",
}
try:
bitrix_response = client.sale.statuslang.add(
fields=fields,
).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.add',
[
'fields' => [
'statusId' => 'RD',
'lid' => 'ru',
'name' => 'Возвращен покупателем',
'description' => 'Покупатель вернул товар по причине наличия дефекта'
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding status language: ' . $e->getMessage();
}
BX24.callMethod(
'sale.statusLang.add',
{
fields: {
statusId: 'RD',
lid: 'ru',
name: 'Возвращен покупателем',
description: 'Покупатель вернул товар по причине наличия дефекта'
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.statusLang.add',
[
'fields' =>
[
'statusId' => 'RD',
'lid' => 'ru',
'name' => 'Возвращен покупателем',
'description' => 'Покупатель вернул товар по причине наличия дефекта'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.statusLang.add", b24.Params{
"fields": b24.Params{
"statusId": "RD",
"lid": "ru",
"name": "Возвращен покупателем",
"description": "Покупатель вернул товар по причине наличия дефекта",
},
})
if err != nil {
return fmt.Errorf("sale.statusLang.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "statusLang".
raw, ok := b24.Unwrap(res.Result, "statusLang")
if !ok {
return fmt.Errorf("в ответе нет ключа statusLang")
}
var item struct {
Description string `json:"description"`
Lid string `json:"lid"`
Name string `json:"name"`
StatusID string `json:"statusId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Description, item.Lid)
Ответ
HTTP-статус: 200
{
"result":{
"statusLang":{
"description":"Покупатель вернул товар по причине наличия дефекта",
"lid":"ru",
"name":"Возвращен покупателем",
"statusId":"RD"
}
},
"time":{
"start":1712218058.514339,
"finish":1712218060.34603,
"duration":1.831691026687622,
"processing":0.042268991470336914,
"date_start":"2024-04-04T11:07:38+03:00",
"date_finish":"2024-04-04T11:07:40+03:00"
}
}
Возвращаемые данные
result
object
Корневой элемент ответа
statusLang
sale_status_lang
Объект с информацией о добавленной локализации статуса
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":201750000003,
"error_description":"Duplicate entry for key [statusId, lid]"
}
| Код | Описание | Значение |
|---|---|---|
201750000003 |
Локализация для переданного статуса уже существует | |
201750000004 |
Передан неизвестный идентификатор языка локализации lid |
|
200040300020 |
Недостаточно прав для добавления локализации статуса | |
100 |
Не указан или пустой параметр fields |
|
0 |
Не переданы обязательные поля структуры fields |
|
0 |
Другие ошибки (например, фатальные ошибки) |

