Add Product Variation 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:
catalogWho can execute the method: a user with the "Create product" permission, permission to modify elements of the variations information block, and one of the permissions: "View product catalog", "View catalog products", or "Edit selling price"
The method catalog.product.offer.add creates a product variation in the variations catalog.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values of the new variation (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
iblockId* |
Identifier of the variations catalog information block. You can retrieve the identifier using the catalog.catalog.list method: the variations catalog has the |
|
name* |
Variation name |
|
parentId |
Identifier of the parent product. The parent can be a simple product or a parent product from the product information block that the variations catalog is linked to. You can retrieve the identifiers using the catalog.product.sku.list and catalog.product.list methods. If |
|
active |
Activity. Possible values:
The method saves any other value as Default: |
|
code |
Symbolic code. The method does not check that the code is unique |
|
xmlId |
External code. If not passed, it matches the variation identifier |
|
sort |
Sorting. The method saves a non-numeric value as Default: |
|
createdBy |
Identifier of the user who created the variation. The method checks that the user exists. Default: the current user |
|
modifiedBy |
Identifier of the user who modified the variation. The method checks that the user exists. Default: the current user |
|
iblockSectionId |
Identifier of the main section. You can retrieve the identifier using the catalog.section.list method. For a nonexistent section, the method returns the |
|
previewText |
Preview description |
|
previewTextType |
Type of the preview description. Possible values:
Default: |
|
detailText |
Detailed description |
|
detailTextType |
Type of the detailed description. Possible values:
Default: |
|
previewPicture |
Preview picture in the format |
|
detailPicture |
Detailed picture in the format |
|
measure |
Identifier of the unit of measurement. You can retrieve the identifier using the catalog.measure.list method |
|
vatId |
VAT rate identifier. You can retrieve the identifier using the catalog.vat.list method. The method checks that the rate exists |
|
vatIncluded |
Whether VAT is included in the price. Possible values:
The method saves any other value as Default: |
|
purchasingPrice |
Purchasing price |
|
purchasingCurrency |
Purchasing price currency, for example |
|
quantity |
Available quantity. The method saves a non-numeric value as |
|
quantityReserved |
Reserved quantity |
|
quantityTrace |
Quantity accounting. Possible values:
Default: |
|
canBuyZero |
Whether purchase is allowed when the product is out of stock. Possible values:
Default: |
|
subscribe |
Whether subscription to the product is allowed. Possible values:
Default: |
|
barcodeMulti |
Unique barcode for each item. Possible values:
Default: |
|
weight |
Weight |
|
length |
Length |
|
width |
Width |
|
height |
Height |
|
recurSchemeLength |
Length of the payment period. Used only in the on-premise version for selling content |
|
recurSchemeType |
Time unit of the payment period. Possible values:
Default: |
|
trialPriceId |
Product for trial payment. Used only in the on-premise version for selling content |
|
withoutOrder |
Renewal without placing an order. Possible values:
Default: |
|
propertyN |
Value of a variation property, where Pass the value as a number, a string, or an object |
The method fills in the id, type, available, bundle, and timestampX fields itself and skips them in fields without an error. The method also skips unknown fields.
Do not pass the dateCreate, dateActiveFrom, and dateActiveTo fields. Currently the method saves any dateCreate value as 2001-11-30T00:00:00 and rejects activity dates in any format with the Incorrect starting date format.<br> or Incorrect expiration date format.<br> error.
Set the variation price using the catalog.price.* methods after creating the variation. The method saves the quantity and purchasingPrice fields even when inventory management is enabled. To keep warehouse stock and the purchasing price consistent with documents under inventory management, use the catalog.document.* methods.
Code Examples
How to Use Examples in Documentation
The example creates the "Red T-shirt, M" variation for the parent product 7603 and sets the size in the property907 list property, the color in the property891 string property, and the preview picture. In the example, the picture content is shortened to iVBORw0KGgo..., so pass the full base64 string.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":27,"name":"Red T-shirt, M","parentId":7603,"active":"Y","code":"tshirt-red-m","xmlId":"tshirt-red-m","sort":100,"measure":9,"vatId":3,"vatIncluded":"Y","purchasingPrice":800,"purchasingCurrency":"EUR","quantity":25,"weight":200,"width":500,"length":700,"height":20,"previewText":"100% cotton","previewPicture":{"fileData":["tshirt-red.png","iVBORw0KGgo..."]},"property907":1603,"property891":"Red"}}' \
https://**put_your_bitrix24_address**/rest/**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":"Red T-shirt, M","parentId":7603,"active":"Y","code":"tshirt-red-m","xmlId":"tshirt-red-m","sort":100,"measure":9,"vatId":3,"vatIncluded":"Y","purchasingPrice":800,"purchasingCurrency":"EUR","quantity":25,"weight":200,"width":500,"length":700,"height":20,"previewText":"100% cotton","previewPicture":{"fileData":["tshirt-red.png","iVBORw0KGgo..."]},"property907":1603,"property891":"Red"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.offer.add
// 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
type OfferProperty = {
value: string
valueId: string
valueEnum?: string
}
type OfferFile = {
id: string
url: string
urlMachine: string
}
// Shape of the offer returned in result (match the "response handling" section of the page)
type Offer = {
id: number
iblockId: number
name: string
active: string
code: string | null
xmlId: string
sort: number | null
type: number
available: string
parentId: OfferProperty | null
quantity: number | null
purchasingPrice?: string | null
purchasingCurrency?: string | null
previewPicture: OfferFile | null
detailPicture: OfferFile | null
dateCreate: ISODate
timestampX: ISODate
[key: `property${number}`]: OfferProperty | OfferProperty[] | null
}
try {
const response = await $b24.actions.v2.call.make<{ offer: Offer }>({
method: 'catalog.product.offer.add',
params: {
fields: {
iblockId: 27,
name: 'Red T-shirt, M',
parentId: 7603,
active: 'Y',
code: 'tshirt-red-m',
xmlId: 'tshirt-red-m',
sort: 100,
measure: 9,
vatId: 3,
vatIncluded: 'Y',
purchasingPrice: 800,
purchasingCurrency: 'EUR',
quantity: 25,
weight: 200,
width: 500,
length: 700,
height: 20,
previewText: '100% cotton',
previewPicture: {
fileData: ['tshirt-red.png', 'iVBORw0KGgo...'],
},
property907: 1603,
property891: 'Red',
},
},
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('Added offer:', result.offer.id, result.offer.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 addOffer() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.product.offer.add',
params: {
fields: {
iblockId: 27,
name: 'Red T-shirt, M',
parentId: 7603,
active: 'Y',
code: 'tshirt-red-m',
xmlId: 'tshirt-red-m',
sort: 100,
measure: 9,
vatId: 3,
vatIncluded: 'Y',
purchasingPrice: 800,
purchasingCurrency: 'EUR',
quantity: 25,
weight: 200,
width: 500,
length: 700,
height: 20,
previewText: '100% cotton',
previewPicture: {
fileData: ['tshirt-red.png', 'iVBORw0KGgo...'],
},
property907: 1603,
property891: 'Red',
},
},
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('Added offer:', result.offer.id, result.offer.name)
} 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": "Red T-shirt, M",
"parentId": 7603,
"active": "Y",
"code": "tshirt-red-m",
"xmlId": "tshirt-red-m",
"sort": 100,
"measure": 9,
"vatId": 3,
"vatIncluded": "Y",
"purchasingPrice": 800,
"purchasingCurrency": "EUR",
"quantity": 25,
"weight": 200,
"width": 500,
"length": 700,
"height": 20,
"previewText": "100% cotton",
"previewPicture": {
"fileData": ["tshirt-red.png", "iVBORw0KGgo..."],
},
"property907": 1603,
"property891": "Red",
},
).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.product.offer.add',
[
'fields' => [
'iblockId' => 27,
'name' => 'Red T-shirt, M',
'parentId' => 7603,
'active' => 'Y',
'code' => 'tshirt-red-m',
'xmlId' => 'tshirt-red-m',
'sort' => 100,
'measure' => 9,
'vatId' => 3,
'vatIncluded' => 'Y',
'purchasingPrice' => 800,
'purchasingCurrency' => 'EUR',
'quantity' => 25,
'weight' => 200,
'width' => 500,
'length' => 700,
'height' => 20,
'previewText' => '100% cotton',
'previewPicture' => [
'fileData' => ['tshirt-red.png', 'iVBORw0KGgo...'],
],
'property907' => 1603,
'property891' => 'Red',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.product.offer.add',
{
fields: {
iblockId: 27,
name: 'Red T-shirt, M',
parentId: 7603,
active: 'Y',
code: 'tshirt-red-m',
xmlId: 'tshirt-red-m',
sort: 100,
measure: 9,
vatId: 3,
vatIncluded: 'Y',
purchasingPrice: 800,
purchasingCurrency: 'EUR',
quantity: 25,
weight: 200,
width: 500,
length: 700,
height: 20,
previewText: '100% cotton',
previewPicture: {
fileData: ['tshirt-red.png', 'iVBORw0KGgo...'],
},
property907: 1603,
property891: 'Red',
},
},
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.offer.add',
[
'fields' => [
'iblockId' => 27,
'name' => 'Red T-shirt, M',
'parentId' => 7603,
'active' => 'Y',
'code' => 'tshirt-red-m',
'xmlId' => 'tshirt-red-m',
'sort' => 100,
'measure' => 9,
'vatId' => 3,
'vatIncluded' => 'Y',
'purchasingPrice' => 800,
'purchasingCurrency' => 'EUR',
'quantity' => 25,
'weight' => 200,
'width' => 500,
'length' => 700,
'height' => 20,
'previewText' => '100% cotton',
'previewPicture' => [
'fileData' => ['tshirt-red.png', 'iVBORw0KGgo...'],
],
'property907' => 1603,
'property891' => 'Red',
],
]
);
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": "Red T-shirt, M",
"parentId": 7603,
"active": "Y",
"code": "tshirt-red-m",
"xmlId": "tshirt-red-m",
"sort": 100,
"measure": 9,
"vatId": 3,
"vatIncluded": "Y",
"purchasingPrice": 800,
"purchasingCurrency": "EUR",
"quantity": 25,
"weight": 200,
"width": 500,
"length": 700,
"height": 20,
"previewText": "100% cotton",
"previewPicture": b24.Params{
"fileData": []string{"tshirt-red.png", "iVBORw0KGgo..."},
},
"property907": 1603,
"property891": "Red",
},
})
if err != nil {
return fmt.Errorf("catalog.product.offer.add: %w", err)
}
// The method wraps the response in an object with the "offer" key.
raw, ok := b24.Unwrap(res.Result, "offer")
if !ok {
return fmt.Errorf("the response has no offer key")
}
// Optional fields can be null, so pointers are used for them.
var item struct {
ID b24.ID `json:"id"`
IblockID int `json:"iblockId"`
Name string `json:"name"`
Active string `json:"active"`
Code *string `json:"code"`
Sort *int `json:"sort"`
Type int `json:"type"`
Quantity *float64 `json:"quantity"`
PurchasingPrice *string `json:"purchasingPrice"`
ParentID *struct {
Value string `json:"value"`
ValueID string `json:"valueId"`
} `json:"parentId"`
PreviewPicture *struct {
ID string `json:"id"`
URL string `json:"url"`
} `json:"previewPicture"`
}
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": {
"offer": {
"active": "Y",
"available": "Y",
"barcodeMulti": "N",
"bundle": "N",
"canBuyZero": "Y",
"code": "tshirt-red-m",
"createdBy": 1269,
"dateActiveFrom": null,
"dateActiveTo": null,
"dateCreate": "2026-11-05T19:19:32+01:00",
"detailPicture": null,
"detailText": null,
"detailTextType": "text",
"height": 20,
"iblockId": 27,
"iblockSection": null,
"iblockSectionId": null,
"id": 7695,
"length": 700,
"measure": 9,
"modifiedBy": 1269,
"name": "Red T-shirt, M",
"parentId": {
"value": "7603",
"valueId": "4149"
},
"previewPicture": {
"id": "40057",
"url": "/rest/catalog.product.download?fields%5BfieldName%5D=previewPicture&fields%5BfileId%5D=40057&fields%5BproductId%5D=7695",
"urlMachine": "/rest/catalog.product.download?fields%5BfieldName%5D=previewPicture&fields%5BfileId%5D=40057&fields%5BproductId%5D=7695"
},
"previewText": "100% cotton",
"previewTextType": "text",
"property429": null,
"property891": {
"value": "Red",
"valueId": "4151"
},
"property895": null,
"property905": null,
"property907": {
"value": "1603",
"valueEnum": "M",
"valueId": "4153"
},
"property909": null,
"property911": null,
"property925": null,
"property937": null,
"purchasingCurrency": "EUR",
"purchasingPrice": "800.00000000",
"quantity": 25,
"quantityReserved": null,
"quantityTrace": "Y",
"recurSchemeLength": null,
"recurSchemeType": "D",
"sort": 100,
"subscribe": "Y",
"timestampX": "2026-11-05T19:19:32+01:00",
"trialPriceId": null,
"type": 4,
"vatId": 3,
"vatIncluded": "Y",
"weight": 200,
"width": 500,
"withoutOrder": "N",
"xmlId": "tshirt-red-m"
}
},
"time": {
"start": 1793895571,
"finish": 1793895572.306547,
"duration": 1.306546926498413,
"processing": 1,
"date_start": "2026-11-05T19:19:31+01:00",
"date_finish": "2026-11-05T19:19:32+01:00",
"operating_reset_at": 1793896140,
"operating": 0.30707502365112305
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.offer |
Object with the fields of the created variation. The method returns all fields and properties of the variation, with empty ones as A property is returned as an object |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "200040500010",
"error_description": "Parent product not found."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access Denied |
The user has none of the "View product catalog", "View catalog products", or "Edit selling price" permissions |
|
|
|
Access Denied |
The user does not have the "Create product" permission |
|
|
|
Access Denied |
The user does not have permission to modify elements of the variations information block |
|
|
|
Access Denied |
The section from |
|
|
|
Parent product not found. |
The parent product from |
|
|
|
Invalid parent product type. |
A variation or a service was passed in |
|
|
|
Could not find value for parameter |
The |
|
|
|
Incorrect fields format |
|
|
|
|
Required fields: name |
The |
|
|
|
iblock is not catalog |
The |
|
|
|
productType is not allowed for this catalog |
The product information block was passed in |
|
|
|
Wrong format of field |
An object or an array was passed in the field instead of a value. The text contains the field name |
|
|
|
VAT vatId is not exists |
The VAT rate from |
|
|
|
Currency purchasingCurrency is not exists |
The currency from |
|
|
|
User createdBy is not exists |
The user from |
|
|
|
Incorrect starting date format. |
The |
|
|
|
Incorrect expiration date format. |
The |
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 |
Continue Learning
- Update Product Variation Fields catalog.product.offer.update
- Get Product Variation Field Values catalog.product.offer.get
- Get List of Product Variations catalog.product.offer.list
- Download Product Variation Files catalog.product.offer.download
- Delete Product Variation catalog.product.offer.delete
- Get Product Variation Fields by Filter catalog.product.offer.getFieldsByFilter