Update Price Type 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: catalog

Who can execute the method: a user with the "Manage Price Types" access permission

The method catalog.priceType.update modifies the values of price type fields.

Method Parameters

Name
type

Description

id*
catalog_price_type.id

Identifier of the price type.

You can retrieve the identifier using the catalog.priceType.list method

fields*
object

Object with the price type fields to change (detailed description).

Pass only the fields you want to change: fields that are not passed keep their current values. The method accepts an empty object without an error and changes nothing

Parameter fields

Required parameters are marked with *

Name
type

Description

name
string

Price type code. The value must not be empty

base
string

Indicates if the price type is base. Possible values:

  • Y — yes
  • N — no

Only one base price type can exist at a time. If you pass Y, the current base type stops being the base one

sort
integer

Sorting. The method stores a non-numeric value as 100 without an error

xmlId
string

External code.

Can be used to synchronize the current price type with a similar position in an external system

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":2,"fields":{"name":"Partner wholesale price","sort":1,"xmlId":"partnerwholesale"}}' \
        https://**put_your_bitrix24_address**/rest/**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":2,"fields":{"name":"Partner wholesale price","sort":1,"xmlId":"partnerwholesale"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.priceType.update
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type PriceTypeUpdateResult = {
          priceType: {
            base: string
            createdBy: number
            dateCreate: ISODate | null
            id: number
            modifiedBy: number
            name: string
            sort: number
            timestampX: ISODate | null
            xmlId: string
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<PriceTypeUpdateResult>({
            method: 'catalog.priceType.update',
            params: {
              id: 2,
              fields: {
                name: 'Partner wholesale price',
                sort: 1,
                xmlId: 'partnerwholesale',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info(result.priceType.id, result.priceType.name)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updatePriceType() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.priceType.update',
                params: {
                  id: 2,
                  fields: {
                    name: 'Partner wholesale price',
                    sort: 1,
                    xmlId: 'partnerwholesale',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info(result.priceType.id, result.priceType.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.price_type.update(
                bitrix_id=2,
                fields={
                    "name": "Partner wholesale price",
                    "sort": 1,
                    "xmlId": "partnerwholesale",
                },
            ).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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.priceType.update',
                    [
                        'id' => 2,
                        'fields' => [
                            'name'  => "Partner wholesale price",
                            'sort'  => 1,
                            'xmlId' => "partnerwholesale",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.priceType.update',
            {
                id: 2,
                fields: {
                    name: "Partner wholesale price",
                    sort: 1,
                    xmlId: "partnerwholesale"
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.priceType.update',
            [
                'id' => 2,
                'fields' => [
                    'name' => 'Partner wholesale price',
                    'sort' => 1,
                    'xmlId' => 'partnerwholesale'
                ]
            ]
        );
        
        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": 2,
        	"fields": b24.Params{
        		"name":  "Partner wholesale price",
        		"sort":  1,
        		"xmlId": "partnerwholesale",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.priceType.update: %w", err)
        }
        
        // The method wraps the response in an object with the "priceType" key.
        raw, ok := b24.Unwrap(res.Result, "priceType")
        if !ok {
        	return fmt.Errorf("no priceType key in the response")
        }
        
        var item struct {
        	Base       string `json:"base"`
        	CreatedBy  int    `json:"createdBy"`
        	DateCreate string `json:"dateCreate"`
        	ID         b24.ID `json:"id"`
        	ModifiedBy int    `json:"modifiedBy"`
        	Name       string `json:"name"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Base, item.CreatedBy)
        

Response Handling

HTTP status: 200

{
            "result": {
                "priceType": {
                    "base": "N",
                    "createdBy": 1269,
                    "dateCreate": "2026-11-03T12:44:53+03:00",
                    "id": 2,
                    "modifiedBy": 1269,
                    "name": "Partner wholesale price",
                    "sort": 1,
                    "timestampX": "2026-11-03T12:45:09+03:00",
                    "xmlId": "partnerwholesale"
                }
            },
            "time": {
                "start": 1793699473,
                "finish": 1793699473.622972,
                "duration": 0.6229720115661621,
                "processing": 0,
                "date_start": "2026-11-03T12:51:13+03:00",
                "date_finish": "2026-11-03T12:51:13+03:00",
                "operating_reset_at": 1793700060,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

result.priceType
catalog_price_type

Object with information about the updated price type

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "201000000000",
            "error_description": "priceType does not exist."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

200040300020

Access Denied

The user does not have the "Manage price types" access permission

400

100

Could not find value for parameter

The required parameter id is not provided

400

100

Could not find value for parameter

The required parameter fields is not provided

400

201000000000

priceType does not exist.

No price type with the specified id exists

400

ERROR_CORE

The price type ID is missing.<br>

An empty string is passed in name

400

0

Error updating price type

Failed to save the price type changes

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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