Добавить локализацию sale.statusLang.add

Scope: sale

Кто может выполнять метод: администратор

Метод добавляет локализацию статуса заказа или доставки.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'sale.statuslang.add',
        		{
        			fields: {
        				statusId: 'RD',
        				lid: 'ru',
        				name: 'Возвращен покупателем',
        				description: 'Покупатель вернул товар по причине наличия дефекта'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(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>';

Обработка ответа

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]"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание
`201750000003`	Локализация для переданного статуса уже существует
`201750000004`	Передан неизвестный идентификатор языка локализации `lid`
`200040300020`	Недостаточно прав для добавления локализации статуса
`100`	Не указан или пустой параметр `fields`
`0`	Не переданы обязательные поля структуры `fields`
`0`	Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Получить список языков для локализации

Получить список локализаций статусов

Добавить локализацию sale.statusLang.add

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение