Add Localization sale.statusLang.add

Scope: sale

Who can execute the method: administrator

This method adds localization for the order or delivery status.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values (detailed description provided below) for adding status localization in the form of a structure: `fields: { statusId: 'value', lid: 'value', name: 'value', description: 'value' }`

Parameter fields

Required parameters are marked with *

Name `type`	Description
statusId* `sale_status.id`	Symbolic identifier of the status
lid* `sale_lang.lid`	Language identifier. Current possible values are listed below: ar — Arabic br — Portuguese de — German en — English fr — French hi — Hindi id — Indonesian in — English (India) it — Italian ja — Japanese la — Spanish ms — Malay pl — Polish de — German sc — Chinese (Simplified) tc — Chinese (Traditional) th — Thai tr — Turkish ua — Ukrainian vn — Vietnamese The list of available languages can be obtained using the method sale.statuslang.getlistlangs
name* `string`	Name of the status for the created localization
description `string`	Description of the status for the created localization

Code Examples

How to Use Examples in Documentation

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":"de","name":"Returned by Customer","description":"The customer returned the product due to a defect"}}' \
        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":"de","name":"Returned by Customer","description":"The customer returned the product due to a defect"},"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: 'de',
                        name: 'Returned by Customer',
                        description: 'The customer returned the product due to a defect'
                    }
                }
            );
            
            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'         => 'de',
                            'name'        => 'Returned by Customer',
                            'description' => 'The customer returned the product due to a defect'
                        ],
                    ]
                );
        
            $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: 'de',
                    name: 'Returned by Customer',
                    description: 'The customer returned the product due to a defect'
                }
            },
            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' => 'de',
                    'name' => 'Returned by Customer',
                    'description' => 'The customer returned the product due to a defect'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "statusLang": {
                    "description": "The customer returned the product due to a defect",
                    "lid": "de",
                    "name": "Returned by Customer",
                    "statusId": "RD"
                }
            },
            "time": {
                "start": 1712218058.514339,
                "finish": 1712218060.34603,
                "duration": 1.831691026687622,
                "processing": 0.042268991470336914,
                "date_start": "2024-04-04T11:07:38+02:00",
                "date_finish": "2024-04-04T11:07:40+02:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
statusLang `sale_status_lang`	Object containing information about the added status localization
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": 201750000003,
            "error_description": "Duplicate entry for key [statusId, lid]"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`201750000003`	Localization for the provided status already exists
`201750000004`	An unknown localization language identifier `lid` was provided
`200040300020`	Insufficient permissions to add status localization
`100`	The `fields` parameter is missing or empty
`0`	Required fields in the `fields` structure are not provided
`0`	Other errors (e.g., fatal errors)

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get List of Languages for Localization

Get List of Status Localizations

Add Localization sale.statusLang.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning