Update Price Type v 3.0 catalog.pricetype.update
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
This 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 catalog.pricetype.update method changes the fields of a price type and returns its fields after the change.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Price type identifier. The identifier can be obtained using the catalog.pricetype.list method or when creating a price type with the catalog.pricetype.add method |
|
fields* |
Object with the price type fields to change. Pass only the fields being changed. Field description An empty |
Parameter fields
|
Name |
Description |
|
name |
Price type name. An empty string and |
|
base |
Indicates whether the price type is base. Possible values:
The strings |
|
sort |
Sort order. Zero and negative values are replaced with |
|
xmlId |
External code of the price type |
The id, timestampX, modifiedBy, dateCreate, and createdBy fields cannot be changed. If you pass them in fields, the method returns an error.
If you pass base: false for the base price type, the flag is removed, and no other type becomes the base one. Bitrix24 is left without a base price type. To change the base type, pass base: true for the new type.
Code Examples
How to Use Examples in Documentation
A call to the new API differs by the /api/ parameter added to the request:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.pricetype.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":31,"fields":{"name":"Partner wholesale price","sort":150}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.pricetype.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":31,"fields":{"name":"Partner wholesale price","sort":150},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.pricetype.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type PriceTypeUpdateResult = {
item: {
id: number
name: string
base: boolean
sort: number
xmlId: string
timestampX: ISODate
modifiedBy: number
dateCreate: ISODate
createdBy: number
}
}
try {
const response = await $b24.actions.v3.call.make<PriceTypeUpdateResult>({
method: 'catalog.pricetype.update',
params: {
id: 31,
fields: {
name: 'Partner wholesale price',
sort: 150,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Price type updated:', result.item.id, result.item.name)
}
} 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 updatePriceType() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.pricetype.update',
params: {
id: 31,
fields: {
name: 'Partner wholesale price',
sort: 150,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Price type updated:', result.item.id, result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updatePriceType)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.pricetype.update(
bitrix_id=31,
fields={
"name": "Partner wholesale price",
"sort": 150,
},
).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.update',
[
'id' => 31,
'fields' => [
'name' => 'Partner wholesale price',
'sort' => 150,
],
]
);
$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.update',
{
id: 31,
fields: {
name: 'Partner wholesale price',
sort: 150,
},
},
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.update',
[
'id' => 31,
'fields' => [
'name' => 'Partner wholesale price',
'sort' => 150,
],
]
);
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.update", b24.Params{
"id": 31,
"fields": b24.Params{
"name": "Partner wholesale price",
"sort": 150,
},
})
if err != nil {
return fmt.Errorf("catalog.pricetype.update: %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("no item key in the response")
}
var item struct {
ID int `json:"id"`
Name string `json:"name"`
Base bool `json:"base"`
Sort int `json:"sort"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 31,
"name": "Partner wholesale price",
"base": false,
"sort": 150,
"xmlId": "wholesale-opt",
"timestampX": "2026-10-22T14:23:13+02:00",
"modifiedBy": 1,
"dateCreate": "2026-10-22T14:23:07+02:00",
"createdBy": 1
}
},
"time": {
"start": 1792668193,
"finish": 1792668193.714955,
"duration": 0.7149550914764404,
"processing": 0,
"date_start": "2026-10-22T14:23:13+02:00",
"date_finish": "2026-10-22T14:23:13+02:00",
"operating_reset_at": 1792668780,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the response data |
|
result.item |
Price type fields after the change. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Price type identifier |
|
name |
Price type name |
|
base |
Indicates whether the price type is base: |
|
sort |
Sort order |
|
xmlId |
External code of the price type. An empty string if the code is not set |
|
timestampX |
Date and time of the last change |
|
modifiedBy |
Identifier of the user who last changed the price type |
|
dateCreate |
Date and time of creation |
|
createdBy |
Identifier of the user who created the price type |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID 999999 was not found."
}
}
|
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
|
Field |
Error description |
How to Fix |
|
|
At least one of the required fields must be not empty: id, filter |
Pass a positive number in |
|
|
At least one field to update must be provided |
Pass at least one field in |
|
|
The field name must not be null |
Pass a non-empty string in |
|
|
The price type ID is missing |
Pass a non-empty string in |
|
|
This request requires data type |
Pass |
|
|
The field base must be true or false |
Do not pass |
|
|
The field sort must be an integer |
Do not pass |
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Field |
Remove read-only fields from |
Filter Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid filter |
The method does not support |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
Check the identifier using the catalog.pricetype.list method |
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 |
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 |