Add Price Type Name Translation v 3.0 catalog.pricetype.lang.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with the "Manage price types" access permission
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method catalog.pricetype.lang.add adds a price type name translation and returns its fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object with the fields of the new translation. Field description |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
catalogGroupId* |
Price type identifier. The identifier can be retrieved using the catalog.pricetype.list method |
|
lang* |
Language code, for example Language codes are returned by the catalog.pricetype.lang.getlanguages method. The method also accepts codes of inactive languages. Only one translation per language can be added for a price type. To change a translation, use catalog.pricetype.lang.update |
|
name* |
Price type name in the selected language. An empty string is allowed |
The id field is filled in automatically; if you pass it in fields, the method returns an error.
If the price type already has a translation into this language, the method returns HTTP status 500 with the INTERNAL_SERVER_ERROR error. Check the existing translations using the catalog.priceTypeLang.list method of the previous API version.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.pricetype.lang.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"catalogGroupId":21,"lang":"en","name":"Wholesale price"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.pricetype.lang.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"catalogGroupId":21,"lang":"en","name":"Wholesale price"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.pricetype.lang.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type PriceTypeLangAddResult = {
item: {
id: number
catalogGroupId: number
lang: string
name: string
}
}
try {
const response = await $b24.actions.v3.call.make<PriceTypeLangAddResult>({
method: 'catalog.pricetype.lang.add',
params: {
fields: {
catalogGroupId: 21,
lang: 'en',
name: 'Wholesale price',
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Translation created:', result.item.id)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addPriceTypeLang() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.pricetype.lang.add',
params: {
fields: {
catalogGroupId: 21,
lang: 'en',
name: 'Wholesale price',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Translation created:', result.item.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addPriceTypeLang)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.pricetype.lang.add(
fields={
"catalogGroupId": 21,
"lang": "en",
"name": "Wholesale price",
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'catalog.pricetype.lang.add',
[
'fields' => [
'catalogGroupId' => 21,
'lang' => 'en',
'name' => 'Wholesale price',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'catalog.pricetype.lang.add',
{
fields: {
catalogGroupId: 21,
lang: 'en',
name: 'Wholesale price',
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.pricetype.lang.add',
[
'fields' => [
'catalogGroupId' => 21,
'lang' => 'en',
'name' => 'Wholesale price',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.pricetype.lang.add", b24.Params{
"fields": b24.Params{
"catalogGroupId": 21,
"lang": "en",
"name": "Wholesale price",
},
})
if err != nil {
return fmt.Errorf("catalog.pricetype.lang.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("the response has no item key")
}
var item struct {
ID int `json:"id"`
CatalogGroupID int `json:"catalogGroupId"`
Lang string `json:"lang"`
Name string `json:"name"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parsing the response: %w", err)
}
fmt.Println(item.ID, item.Lang, item.Name)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 309,
"catalogGroupId": 21,
"lang": "en",
"name": "Wholesale price"
}
},
"time": {
"start": 1792668051,
"finish": 1792668051.073813,
"duration": 0.07381296157836914,
"processing": 0,
"date_start": "2026-10-22T14:20:51+02:00",
"date_finish": "2026-10-22T14:20:51+02:00",
"operating_reset_at": 1792668600,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.item |
Fields of the created translation. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Translation identifier. It is required to update and delete the translation |
|
catalogGroupId |
Price type identifier |
|
lang |
Language code |
|
name |
Price type name in this language |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating request object.",
"validation": [
{
"message": "The specified price type does not exist",
"field": "201000000000"
},
{
"message": "The specified language does not exist",
"field": "201200000010"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
In the price type and language check errors, the field field contains a numeric error code instead of the parameter name.
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
The specified price type does not exist |
Check the price type identifier using the catalog.pricetype.list method |
|
|
The specified language does not exist |
Pass a language code from the response of the catalog.pricetype.lang.getlanguages method |
|
|
This request requires data type |
Pass a string |
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field "catalogGroupId" is empty |
Pass |
|
|
Required field "lang" is empty |
Pass |
|
|
Required field "name" is empty |
Pass |
|
|
Field "id" is read-only |
Remove |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass only |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Make sure the user has the "Manage price types" access permission |
Internal Error
Error Code: INTERNAL_SERVER_ERROR
HTTP status: 500
|
Field |
Error description |
How to Fix |
|
|
Internal server error |
The price type already has a translation into this language. Change the existing translation using the catalog.pricetype.lang.update method |
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 |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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
- Update Price Type Name Translation v 3.0 catalog.pricetype.lang.update
- Delete Price Type Name Translation v 3.0 catalog.pricetype.lang.delete
- Get Available Languages for Translation v 3.0 catalog.pricetype.lang.getlanguages
- Get List of Price Type Name Translation Fields v 3.0 catalog.pricetype.lang.field.list