Update the translation of the price type name catalog.priceTypeLang.update
Scope:
catalogWho can execute the method: administrator
This method updates the translation of the price type name by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the price type name translation |
|
|
fields* |
Field values for updating the price type name translation |
Fields Parameter
|
Name |
Description |
|
catalogGroupId |
Identifier of the price type. You can obtain the identifiers of price types using the catalog.priceType.list method. |
|
name |
Translation of the price type name |
|
lang |
Language identifier. You can obtain the identifiers of languages using the catalog.priceTypeLang.getLanguages method. |
At least one field must be specified in the fields parameter.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6,"fields":{"name":"Base Price"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.priceTypeLang.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6,"fields":{"name":"Base Price"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.priceTypeLang.update
try
{
const response = await $b24.callMethod(
'catalog.priceTypeLang.update',
{
id: 6,
fields: {
name: "Base Price",
}
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.priceTypeLang.update',
[
'id' => 6,
'fields' => [
'name' => "Base 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 updating price type language: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.priceTypeLang.update',
{
id: 6,
fields: {
name: "Base Price",
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.priceTypeLang.update',
[
'id' => 6,
'fields' => [
'name' => 'Base Price'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"priceTypeLang": {
"catalogGroupId": 1,
"id": 6,
"lang": "kz",
"name": "Base Price"
}
},
"time": {
"start": 1733843735.3651,
"finish": 1733843735.75101,
"duration": 0.385910987854004,
"processing": 0.0111708641052246,
"date_start": "2024-12-10T17:15:35+02:00",
"date_finish": "2024-12-10T17:15:35+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
priceTypeLang |
Object containing information about the updated price type name translation |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": 0,
"error_description":"Required fields: name"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Insufficient permissions to edit |
|
|
No translation of the price type name with such identifier exists |
|
|
Language with the specified identifier does not exist |
|
|
Price type with the specified identifier does not exist |
|
|
Translation for the specified pair: price type and language identifier already exists |
|
|
Parameter |
|
|
Parameter |
|
|
Required fields of the |
|
|
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 |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Add Translation for Price Type Name catalog.priceTypeLang.add
- Get the values of the fields for the price type name translation catalog.priceTypeLang.get
- Get a list of translations for price type names by the filter catalog.priceTypeLang.list
- Delete Translation of Price Type Name catalog.priceTypeLang.delete
- Get Available Languages for Translation catalog.priceTypeLang.getLanguages
- Get Fields for Price Type Translation catalog.priceTypeLang.getFields