Create Price Type v 3.0 catalog.pricetype.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: catalog

Who 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.add method creates a price type and returns its fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new price type. Field description

Parameter fields

Name
type

Description

name*
string

Price type name. An empty string and null cause a validation error. Price type names can be repeated

base
boolean

Indicates whether the price type is base.

Possible values:

  • true — the price type becomes the base one. The flag is automatically removed from the previous base type
  • false — a regular price type

The strings Y and N are not accepted, and null causes a validation error.

Default: false

sort
integer

Sort order. Zero and negative values are replaced with 100, and null causes a validation error.

Default: 100

xmlId
string

External code of the price type. Can be used to synchronize with an external system

The id, timestampX, modifiedBy, dateCreate, and createdBy fields are filled in automatically. If you pass them in fields, the method returns an error.

A new price type is available for viewing and purchasing only to the administrators group. To make it available to other user groups, use the catalog.pricetype.group.* methods.

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.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Wholesale price","sort":200,"xmlId":"wholesale-opt"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.pricetype.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"name":"Wholesale price","sort":200,"xmlId":"wholesale-opt"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.pricetype.add
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type PriceTypeAddResult = {
          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<PriceTypeAddResult>({
            method: 'catalog.pricetype.add',
            params: {
              fields: {
                name: 'Wholesale price',
                sort: 200,
                xmlId: 'wholesale-opt',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Price type 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 addPriceType() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.pricetype.add',
                params: {
                  fields: {
                    name: 'Wholesale price',
                    sort: 200,
                    xmlId: 'wholesale-opt',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Price type created:', result.item.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addPriceType)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.pricetype.add(
                fields={
                    "name": "Wholesale price",
                    "sort": 200,
                    "xmlId": "wholesale-opt",
                },
            ).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.add',
                    [
                        'fields' => [
                            'name' => 'Wholesale price',
                            'sort' => 200,
                            'xmlId' => 'wholesale-opt',
                        ],
                    ]
                );
        
            $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.add',
            {
                fields: {
                    name: 'Wholesale price',
                    sort: 200,
                    xmlId: 'wholesale-opt',
                },
            },
            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.add',
            [
                'fields' => [
                    'name' => 'Wholesale price',
                    'sort' => 200,
                    'xmlId' => 'wholesale-opt',
                ],
            ]
        );
        
        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.add", b24.Params{
        	"fields": b24.Params{
        		"name":  "Wholesale price",
        		"sort":  200,
        		"xmlId": "wholesale-opt",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.pricetype.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("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": "Wholesale price",
                    "base": false,
                    "sort": 200,
                    "xmlId": "wholesale-opt",
                    "timestampX": "2026-10-22T14:23:07+02:00",
                    "modifiedBy": 1,
                    "dateCreate": "2026-10-22T14:23:07+02:00",
                    "createdBy": 1
                }
            },
            "time": {
                "start": 1792668187,
                "finish": 1792668187.97024,
                "duration": 0.9702401161193848,
                "processing": 0,
                "date_start": "2026-10-22T14:23:07+02:00",
                "date_finish": "2026-10-22T14:23:07+02:00",
                "operating_reset_at": 1792668780,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.item
object

Fields of the created price type. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Price type identifier

name
string

Price type name

base
boolean

Indicates whether the price type is base: true — base, false — regular

sort
integer

Sort order

xmlId
string

External code of the price type. An empty string if the code is not set

timestampX
datetime

Date and time of the last change

modifiedBy
integer

Identifier of the user who last changed the price type

dateCreate
datetime

Date and time of creation

createdBy
integer

Identifier of the user who created the price type

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
                "message": "Error validating object.",
                "validation": [
                    {
                        "message": "Required field \"name\" is empty.",
                        "field": "name"
                    }
                ]
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

name

Required field name is empty

Pass name in fields

#FIELD#

Field #FIELD# is read-only

Remove read-only fields from fields: id, timestampX, modifiedBy, dateCreate, createdBy

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

name

The field name must not be null

Pass a non-empty string in name

-

The price type ID is missing<br>

Pass a non-empty string in name

base

This request requires data type bool in field base

Pass true or false, not Y or N

base

The field base must be true or false

Do not pass null in base

sort

The field sort must be an integer

Do not pass null in sort

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity PriceTypeDto

Pass only name, base, sort, xmlId in fields

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