Add Product Variation v 3.0 catalog.product.offer.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 "Create product" permission and one of the permissions: "View product catalog", "View catalog products", or "Edit selling price"

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.product.offer.add creates a variation in the offers catalog and returns its fields.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

Object with the fields of the new variation. Field description

Parameter fields

Required parameters are marked with *

Name
type

Description

iblockId*
integer

Identifier of the offers catalog information block.

The identifier can be retrieved using the catalog.catalog.list method: it is the catalog whose productIblockId is greater than 0

name*
string

Variation name

code
string

Symbolic code

xmlId
string

External code. If not passed on creation, it matches id

active
string

Activity flag.

Possible values:

  • Y — active
  • N — inactive

Any value other than Y is saved as N.

Default: Y

sort
integer

Sort order.

Default: 500

createdBy
integer

Identifier of the user who created the record. The identifier can be retrieved using the user.get method

modifiedBy
integer

Identifier of the user who modified the record. Defaults to the current user

dateActiveFrom
datetime

Activity start date in ISO 8601 format

dateActiveTo
datetime

Activity end date in ISO 8601 format

previewText
string

Preview description

previewTextType
string

Preview description type.

Possible values:

  • text — text
  • html — HTML

Default: text

previewPicture
object

Preview picture. The method currently does not save the field value, see the warning below for details

detailText
string

Detailed description

detailTextType
string

Detailed description type.

Possible values:

  • text — text
  • html — HTML

Default: text

detailPicture
object

Detail picture. The method currently does not save the field value, see the warning below for details

iblockSectionId
integer

Identifier of the main section.

The identifier can be retrieved using the catalog.section.list method. For a non-existent section, the method returns an access error

iblockSection
array

Array of identifiers of all sections to link the product to

quantity
double

Available quantity. The value is not saved when inventory management is enabled

quantityReserved
double

Reserved quantity

quantityTrace
string

Quantity tracking.

Possible values:

  • Y — enabled
  • N — disabled

Always Y when inventory management is enabled

canBuyZero
string

Allow purchase when the product is out of stock.

Possible values:

  • Y — yes
  • N — no

subscribe
string

Allow subscription to the product.

Possible values:

  • Y — yes
  • N — no

vatId
integer

VAT rate identifier. The identifier can be retrieved using the catalog.vat.list method

vatIncluded
string

Whether VAT is included in the price.

Possible values:

  • Y — yes
  • N — no

purchasingPrice
double

Purchase price. The value is not saved when inventory management is enabled

purchasingCurrency
string

Purchase price currency, for example EUR. The list of currencies can be retrieved using the crm.currency.list method. The value is not saved when inventory management is enabled

barcodeMulti
string

Unique barcodes for each item.

Possible values:

  • Y — yes
  • N — no

weight
double

Weight

length
double

Length

width
double

Width

height
double

Height

measure
integer

Unit of measurement identifier. The identifier can be retrieved using the catalog.measure.list method

recurSchemeLength
integer

Payment period length. Used only in the on-premise version for content sales

recurSchemeType
string

Payment period time unit. Used only in the on-premise version for content sales

trialPriceId
integer

Product for trial payment. Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order: Y or N. Used only in the on-premise version for content sales

quantityTraceRaw
string

Quantity tracking, taking the default value into account.

Possible values:

  • Y — enabled
  • N — disabled
  • D — according to the module settings

paymentType
string

Payment type.

Possible values:

  • S — one-time
  • R — recurring
  • T — trial

Used only in the on-premise version for content sales

subscribeRaw
string

Product subscription, taking the default value into account.

Possible values:

  • Y — allowed
  • N — not allowed
  • D — according to the module settings

canBuyZeroRaw
string

Purchase when out of stock, taking the default value into account.

Possible values:

  • Y — allowed
  • N — not allowed
  • D — according to the module settings

properties
object

Product property values. The key is PROPERTY_{id}, where {id} is the property identifier. The value can be passed as a string, a number, or a {"VALUE": ...} object; for a multiple property, as an array of such values.

Keys of any other form cause a validation error. One property cannot be passed under two keys, for example PROPERTY_101 and 101.

To link the variation to a parent product, pass its identifier in the binding property, for example {"PROPERTY_101": 7553}. The binding property identifier is the skuPropertyId field of the offers catalog, returned by the catalog.catalog.get method. The parent product must be a simple product or a parent product from the product information block of this catalog. If the binding property is not passed, a variation without a parent product is created

The id, type, available, bundle, dateCreate, and timestampX fields are filled in automatically. If you pass id or type in fields, the method returns an error.

The method accepts the previewPicture and detailPicture fields in the {"fileData": ["file_name", "base64_content"]} and {"remove": "Y"} formats but currently does not save them: the picture is neither added nor removed, and no error occurs. Add product images using the catalog.product.image.add method.

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"iblockId":27,"name":"DOCS-V3-OFFER Blue T-shirt M","code":"docs-v3-offer-blue-m","measure":9,"vatId":1,"vatIncluded":"Y","weight":200,"properties":{"PROPERTY_101":7553}}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.offer.add
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"iblockId":27,"name":"DOCS-V3-OFFER Blue T-shirt M","code":"docs-v3-offer-blue-m","measure":9,"vatId":1,"vatIncluded":"Y","weight":200,"properties":{"PROPERTY_101":7553}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.offer.add
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type OfferAddResult = {
          item: {
            id: number
            iblockId: number
            name: string
            type: number
            properties: Record<string, unknown>
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<OfferAddResult>({
            method: 'catalog.product.offer.add',
            params: {
              fields: {
                iblockId: 27,
                name: 'DOCS-V3-OFFER Blue T-shirt M',
                code: 'docs-v3-offer-blue-m',
                measure: 9,
                vatId: 1,
                vatIncluded: 'Y',
                weight: 200,
                properties: {
                  PROPERTY_101: 7553,
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Created:', result.item.id, result.item.type)
          }
        } 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 addOffer() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.offer.add',
                params: {
                  fields: {
                    iblockId: 27,
                    name: 'DOCS-V3-OFFER Blue T-shirt M',
                    code: 'docs-v3-offer-blue-m',
                    measure: 9,
                    vatId: 1,
                    vatIncluded: 'Y',
                    weight: 200,
                    properties: {
                      PROPERTY_101: 7553,
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Created:', result.item.id, result.item.type)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addOffer)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.offer.add(
                fields={
                    "iblockId": 27,
                    "name": "DOCS-V3-OFFER Blue T-shirt M",
                    "code": "docs-v3-offer-blue-m",
                    "measure": 9,
                    "vatId": 1,
                    "vatIncluded": "Y",
                    "weight": 200,
                    "properties": {
                        "PROPERTY_101": 7553,
                    },
                },
            ).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.product.offer.add',
                    [
                        'fields' => [
                            'iblockId' => 27,
                            'name' => 'DOCS-V3-OFFER Blue T-shirt M',
                            'code' => 'docs-v3-offer-blue-m',
                            'measure' => 9,
                            'vatId' => 1,
                            'vatIncluded' => 'Y',
                            'weight' => 200,
                            'properties' => [
                                'PROPERTY_101' => 7553,
                            ],
                        ],
                    ]
                );
        
            $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.product.offer.add',
            {
                fields: {
                    iblockId: 27,
                    name: 'DOCS-V3-OFFER Blue T-shirt M',
                    code: 'docs-v3-offer-blue-m',
                    measure: 9,
                    vatId: 1,
                    vatIncluded: 'Y',
                    weight: 200,
                    properties: {
                        PROPERTY_101: 7553,
                    },
                },
            },
            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.product.offer.add',
            [
                'fields' => [
                    'iblockId' => 27,
                    'name' => 'DOCS-V3-OFFER Blue T-shirt M',
                    'code' => 'docs-v3-offer-blue-m',
                    'measure' => 9,
                    'vatId' => 1,
                    'vatIncluded' => 'Y',
                    'weight' => 200,
                    'properties' => [
                        'PROPERTY_101' => 7553,
                    ],
                ],
            ]
        );
        
        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.product.offer.add", b24.Params{
        	"fields": b24.Params{
        		"iblockId": 27,
        		"name": "DOCS-V3-OFFER Blue T-shirt M",
        		"code": "docs-v3-offer-blue-m",
        		"measure": 9,
        		"vatId": 1,
        		"vatIncluded": "Y",
        		"weight": 200,
        		"properties": b24.Params{
        			"PROPERTY_101": 7553,
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.product.offer.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"`
        	Type int    `json:"type"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Type)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 7555,
                    "iblockId": 27,
                    "name": "DOCS-V3-OFFER Blue T-shirt M",
                    "code": "docs-v3-offer-blue-m",
                    "xmlId": "7555",
                    "active": "Y",
                    "sort": 500,
                    "createdBy": 1,
                    "modifiedBy": 1,
                    "dateCreate": "2026-10-22T12:18:58+02:00",
                    "timestampX": "2026-10-22T12:18:58+02:00",
                    "dateActiveFrom": null,
                    "dateActiveTo": null,
                    "previewText": null,
                    "previewTextType": "text",
                    "previewPicture": null,
                    "detailText": null,
                    "detailTextType": "text",
                    "detailPicture": null,
                    "iblockSectionId": null,
                    "iblockSection": [],
                    "type": 4,
                    "available": "Y",
                    "bundle": "N",
                    "quantity": 0,
                    "quantityReserved": 0,
                    "quantityTrace": "Y",
                    "canBuyZero": "Y",
                    "subscribe": "Y",
                    "vatId": 1,
                    "vatIncluded": "Y",
                    "purchasingPrice": null,
                    "purchasingCurrency": null,
                    "barcodeMulti": "N",
                    "weight": 200,
                    "length": null,
                    "width": null,
                    "height": null,
                    "measure": 9,
                    "recurSchemeLength": null,
                    "recurSchemeType": "D",
                    "trialPriceId": null,
                    "withoutOrder": "N",
                    "quantityTraceRaw": "D",
                    "paymentType": "S",
                    "subscribeRaw": "D",
                    "canBuyZeroRaw": "D",
                    "properties": {
                        "PROPERTY_101": {
                            "VALUE": "7553",
                            "VALUE_ID": "4019"
                        },
                        "PROPERTY_907": null,
                        "PROPERTY_905": null,
                        "PROPERTY_429": null,
                        "PROPERTY_891": null,
                        "PROPERTY_895": null,
                        "PROPERTY_909": null,
                        "PROPERTY_911": null,
                        "PROPERTY_925": null,
                        "PROPERTY_937": null
                    }
                }
            },
            "time": {
                "start": 1792660738,
                "finish": 1792660738.516739,
                "duration": 0.5167388916015625,
                "processing": 0,
                "date_start": "2026-10-22T12:18:58+02:00",
                "date_finish": "2026-10-22T12:18:58+02:00",
                "operating_reset_at": 1792660980,
                "operating": 0.12495088577270508
            }
        }
        

Returned Data

Name
type

Description

result
object

Response data object

result.item
object

Fields of the created variation. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Variation identifier

iblockId
integer

Identifier of the offers catalog information block

name
string

Variation name

code
string or null

Symbolic code

xmlId
string

External code. If not set, it matches id

active
string

Activity flag: Y — active, N — inactive

sort
integer

Sort order

createdBy
integer

Identifier of the user who created the record

modifiedBy
integer

Identifier of the user who last modified the record

dateCreate
datetime

Creation date and time

timestampX
datetime

Date and time of the last modification

dateActiveFrom
datetime or null

Activity start date

dateActiveTo
datetime or null

Activity end date

previewText
string or null

Preview description

previewTextType
string

Preview description type: text or html

previewPicture
string or null

Preview picture file identifier

detailText
string or null

Detailed description

detailTextType
string

Detailed description type: text or html

detailPicture
string or null

Detail picture file identifier

iblockSectionId
integer or null

Identifier of the main section

iblockSection
array

Array of identifiers of all sections the product is linked to

type
integer

Product type: 4 — variation with a parent product, 5 — variation without a parent product

available
string

Availability for purchase: Y — available, N — unavailable

bundle
string

Whether the product has a set: Y — yes, N — no

quantity
double

Available quantity

quantityReserved
double

Reserved quantity

quantityTrace
string

Whether quantity tracking is enabled: Y — yes, N — no

canBuyZero
string

Whether purchase is allowed when the product is out of stock: Y — yes, N — no

subscribe
string

Whether subscription to the product is allowed: Y — yes, N — no

vatId
integer or null

VAT rate identifier

vatIncluded
string

Whether VAT is included in the price: Y — yes, N — no

purchasingPrice
double or null

Purchase price. Returned if the user has the "View purchase price" permission

purchasingCurrency
string or null

Purchase price currency. Returned if the user has the "View purchase price" permission

barcodeMulti
string

Unique barcodes for each item: Y — yes, N — no

weight
double or null

Weight

length
double or null

Length

width
double or null

Width

height
double or null

Height

measure
integer or null

Unit of measurement identifier

recurSchemeLength
integer or null

Payment period length. Used only in the on-premise version for content sales

recurSchemeType
string

Payment period time unit. Used only in the on-premise version for content sales

trialPriceId
integer or null

Product for trial payment. Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order: Y — yes, N — no. Used only in the on-premise version for content sales

quantityTraceRaw
string

Saved quantity tracking value: Y — yes, N — no, D — according to the module settings

paymentType
string

Payment type: S — one-time, R — recurring, T — trial. Used only in the on-premise version for content sales

subscribeRaw
string

Saved subscription value: Y — yes, N — no, D — according to the module settings

canBuyZeroRaw
string

Saved value of purchase when out of stock: Y — yes, N — no, D — according to the module settings

properties
object

Product property values. The keys are PROPERTY_{id}, where {id} is the property identifier. The value is null, a {"VALUE": ..., "VALUE_ID": ...} object, or an array of such objects for a multiple property

A variation with a parent product gets type 4, and a variation without a parent product gets type 5. A parent product without variations changes its type from 6 to 3 after the first variation is added.

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

iblockId

Required field iblockId is empty

Pass iblockId in fields

name

Required field name is empty

Pass name in fields

id

Field id is read-only

Remove id from fields

type

Field type is read-only

Remove type from fields: the type is set automatically

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

In some errors, the field field contains a numeric error code instead of a field name.

Field

Error description

How to Fix

fields

Required field fields is missing

Pass the fields object

iblockId

This request requires data type int in field iblockId

Pass a number

200040300000

Iblock Not Found

Pass the identifier of an existing catalog information block

-

productType is not allowed for this catalog

Pass the identifier of the offers catalog information block

-

VAT vatId is not exists

Pass the identifier of an existing VAT rate

-

User createdBy is not exists

Pass the identifier of an existing user. A similar error is returned for modifiedBy

-

Currency purchasingCurrency is not exists

Pass the code of an existing currency

-

The properties field accepts only the property keys PROPERTY_{id}, unknown keys: #KEYS#

Pass only keys of the PROPERTY_{id} form in properties

-

The properties field names one property by several keys: #KEYS#

Pass each property under one key

200040500010

Parent product not found.

Pass the identifier of an existing parent product in the binding property

200040500020

Invalid parent product type.

Only a simple product or a parent product can be the parent product. A variation or a service cannot be specified

200040500020

Invalid information block of the parent product.

Pass a parent product from the product information block that the offers catalog is linked to

-

Parent product must be a single value.

Pass a single identifier in the binding property

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity ProductDto

Pass only the fields from the Parameter fields table in fields

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Check the user's permissions for the catalog and the information block. The error also occurs if the section from iblockSectionId does not exist

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