Добавить товар v 3.0 catalog.product.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Создание товара» и одним из прав: «Просмотр каталога товаров», «Просмотр товаров каталога» или «Изменение цены продажи товара»
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.product.add создает простой товар в торговом каталоге и возвращает его поля.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с полями нового товара. Описание полей |
Параметр fields
|
Название |
Описание |
|
iblockId* |
Идентификатор инфоблока торгового каталога. Идентификатор можно получить методом catalog.catalog.list. Инфоблок каталога вариаций не подходит: метод вернет ошибку «Неверный тип товара» |
|
name* |
Название товара |
|
code |
Символьный код |
|
xmlId |
Внешний код. Если не передать, совпадет с идентификатором товара |
|
active |
Активность товара. Возможные значения:
Другие значения сохраняются как По умолчанию: |
|
sort |
Сортировка. По умолчанию: |
|
createdBy |
Идентификатор пользователя, который создал товар. Идентификатор можно получить методом user.get |
|
modifiedBy |
Идентификатор пользователя, который изменил товар |
|
dateActiveFrom |
Дата начала активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только |
|
dateActiveTo |
Дата окончания активности. Сейчас дату нельзя задать методами REST 3.0: значение в формате ISO 8601 вызывает ошибку «Wrong format of field», значения в других форматах — ошибку типа данных. Принимается только |
|
previewText |
Описание для анонса |
|
previewTextType |
Тип описания для анонса. Возможные значения:
По умолчанию: |
|
previewPicture |
Картинка для анонса. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате |
|
detailText |
Детальное описание |
|
detailTextType |
Тип детального описания. Возможные значения:
По умолчанию: |
|
detailPicture |
Детальная картинка. Сейчас файл нельзя загрузить или удалить методами REST 3.0: значение в формате |
|
iblockSectionId |
Идентификатор основного раздела. Идентификатор можно получить методом catalog.section.list |
|
iblockSection |
Массив идентификаторов разделов, к которым нужно привязать товар, например |
|
quantity |
Доступное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним |
|
quantityReserved |
Зарезервированное количество. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним |
|
quantityTrace |
Режим количественного учета. Возможные значения:
При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним |
|
canBuyZero |
Разрешить покупку при отсутствии товара. Возможные значения:
|
|
subscribe |
Разрешить подписку на товар. Возможные значения:
|
|
vatId |
Идентификатор ставки НДС. Идентификатор можно получить методом catalog.vat.list |
|
vatIncluded |
НДС включен в цену. Возможные значения:
|
|
purchasingPrice |
Закупочная цена. При включенном складском учете значение не сохраняется: метод не вернет ошибку, но поле останется прежним |
|
purchasingCurrency |
Валюта закупочной цены, например |
|
barcodeMulti |
Уникальный штрихкод для каждого экземпляра. Возможные значения:
|
|
weight |
Вес |
|
length |
Длина |
|
width |
Ширина |
|
height |
Высота |
|
measure |
Идентификатор единицы измерения. Идентификатор можно получить методом catalog.measure.list |
|
recurSchemeLength |
Длина периода оплаты. Используется только в коробочной версии для продажи контента |
|
recurSchemeType |
Единица времени периода оплаты. Используется только в коробочной версии для продажи контента |
|
trialPriceId |
Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента |
|
withoutOrder |
Продление без оформления заказа. Используется только в коробочной версии для продажи контента |
|
quantityTraceRaw |
Режим количественного учета с учетом настроек модуля: |
|
paymentType |
Тип оплаты. Используется только в коробочной версии для продажи контента |
|
subscribeRaw |
Разрешение подписки с учетом настроек модуля: |
|
canBuyZeroRaw |
Разрешение покупки при отсутствии товара с учетом настроек модуля: |
|
properties |
Значения свойств товара. Ключ — Значение одиночного свойства передайте строкой или числом, множественного — массивом значений. Идентификаторы свойств можно получить методом catalog.productProperty.list. Свойства типа «Файл» сейчас не сохраняются |
Поля id, type, available, bundle, dateCreate и timestampX заполняются автоматически. Если передать их в fields, метод вернет ошибку.
Сейчас методы REST 3.0 не сохраняют файлы товара: картинки previewPicture, detailPicture и значения свойств типа «Файл». Загрузите файлы методом прежней версии catalog.product.update.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":25,"name":"Футболка базовая","code":"tshirt-basic","iblockSectionId":41,"vatId":1,"vatIncluded":"Y","measure":9,"previewText":"Футболка из хлопка","properties":{"PROPERTY_301":"TS-001","PROPERTY_305":["Хлопок","Полиэстер"]}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":25,"name":"Футболка базовая","code":"tshirt-basic","iblockSectionId":41,"vatId":1,"vatIncluded":"Y","measure":9,"previewText":"Футболка из хлопка","properties":{"PROPERTY_301":"TS-001","PROPERTY_305":["Хлопок","Полиэстер"]}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductResult = {
item: {
id: number
iblockId: number
name: string
code: string | null
active: 'Y' | 'N'
iblockSectionId: number | null
type: number
vatId: number | null
measure: number | null
dateCreate: ISODate
properties: Record<string, { VALUE: string, VALUE_ID: string } | Array<{ VALUE: string, VALUE_ID: string }> | null>
}
}
try {
const response = await $b24.actions.v3.call.make<ProductResult>({
method: 'catalog.product.add',
params: {
fields: {
iblockId: 25,
name: 'Футболка базовая',
code: 'tshirt-basic',
iblockSectionId: 41,
vatId: 1,
vatIncluded: 'Y',
measure: 9,
previewText: 'Футболка из хлопка',
properties: {
PROPERTY_301: 'TS-001',
PROPERTY_305: ['Хлопок', 'Полиэстер'],
},
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Product 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 product() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.add',
params: {
fields: {
iblockId: 25,
name: 'Футболка базовая',
code: 'tshirt-basic',
iblockSectionId: 41,
vatId: 1,
vatIncluded: 'Y',
measure: 9,
previewText: 'Футболка из хлопка',
properties: {
PROPERTY_301: 'TS-001',
PROPERTY_305: ['Хлопок', 'Полиэстер'],
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Product created:', result.item.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', product)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.add(
fields={
"iblockId": 25,
"name": "Футболка базовая",
"code": "tshirt-basic",
"iblockSectionId": 41,
"vatId": 1,
"vatIncluded": "Y",
"measure": 9,
"previewText": "Футболка из хлопка",
"properties": {
"PROPERTY_301": "TS-001",
"PROPERTY_305": ["Хлопок", "Полиэстер"],
},
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'catalog.product.add',
[
'fields' => [
'iblockId' => 25,
'name' => 'Футболка базовая',
'code' => 'tshirt-basic',
'iblockSectionId' => 41,
'vatId' => 1,
'vatIncluded' => 'Y',
'measure' => 9,
'previewText' => 'Футболка из хлопка',
'properties' => [
'PROPERTY_301' => 'TS-001',
'PROPERTY_305' => ['Хлопок', 'Полиэстер'],
],
],
]
);
$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();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'catalog.product.add',
{
fields: {
iblockId: 25,
name: 'Футболка базовая',
code: 'tshirt-basic',
iblockSectionId: 41,
vatId: 1,
vatIncluded: 'Y',
measure: 9,
previewText: 'Футболка из хлопка',
properties: {
PROPERTY_301: 'TS-001',
PROPERTY_305: ['Хлопок', 'Полиэстер'],
},
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.product.add',
[
'fields' => [
'iblockId' => 25,
'name' => 'Футболка базовая',
'code' => 'tshirt-basic',
'iblockSectionId' => 41,
'vatId' => 1,
'vatIncluded' => 'Y',
'measure' => 9,
'previewText' => 'Футболка из хлопка',
'properties' => [
'PROPERTY_301' => 'TS-001',
'PROPERTY_305' => ['Хлопок', 'Полиэстер'],
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.add", b24.Params{
"fields":b24.Params{
"iblockId": 25,
"name": "Футболка базовая",
"code": "tshirt-basic",
"iblockSectionId":41,
"vatId": 1,
"vatIncluded": "Y",
"measure": 9,
"previewText": "Футболка из хлопка",
"properties": b24.Params{
"PROPERTY_301":"TS-001",
"PROPERTY_305":[]string{"Хлопок", "Полиэстер"},
},
},
})
if err != nil {
return fmt.Errorf("catalog.product.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID int `json:"id"`
Name string `json:"name"`
Type int `json:"type"`
Properties map[string]json.RawMessage `json:"properties"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 7549,
"iblockId": 25,
"name": "Футболка базовая",
"code": "tshirt-basic",
"xmlId": "7549",
"active": "Y",
"sort": 500,
"createdBy": 1,
"modifiedBy": 1,
"dateCreate": "2026-10-22T12:17:25+03:00",
"timestampX": "2026-10-22T12:17:25+03:00",
"dateActiveFrom": null,
"dateActiveTo": null,
"previewText": "Футболка из хлопка",
"previewTextType": "text",
"previewPicture": null,
"detailText": null,
"detailTextType": "text",
"detailPicture": null,
"iblockSectionId": 41,
"iblockSection": [
41
],
"type": 1,
"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": 0,
"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_301": {
"VALUE": "TS-001",
"VALUE_ID": "4003"
},
"PROPERTY_303": null,
"PROPERTY_305": [
{
"VALUE": "Хлопок",
"VALUE_ID": "4005"
},
{
"VALUE": "Полиэстер",
"VALUE_ID": "4007"
}
],
"PROPERTY_359": null
}
}
},
"time": {
"start": 1792660645,
"finish": 1792660645.871675,
"duration": 0.8716750144958496,
"processing": 0,
"date_start": "2026-10-22T12:17:25+03:00",
"date_finish": "2026-10-22T12:17:25+03:00",
"operating_reset_at": 1792660860,
"operating": 0.38492894172668457
}
}
В ответе properties содержит все свойства инфоблока. В примере показана часть свойств.
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Поля созданного товара. Описание полей |
|
time |
Информация о времени выполнения запроса |
Объект item
|
Название |
Описание |
|
id |
Идентификатор товара |
|
iblockId |
Идентификатор инфоблока торгового каталога |
|
name |
Название товара |
|
code |
Символьный код |
|
xmlId |
Внешний код. Если не задан при создании, совпадает с |
|
active |
Активность товара: |
|
sort |
Сортировка |
|
createdBy |
Идентификатор пользователя, который создал товар |
|
modifiedBy |
Идентификатор пользователя, который последним изменил товар |
|
dateCreate |
Дата и время создания в формате ISO 8601 |
|
timestampX |
Дата и время последнего изменения в формате ISO 8601 |
|
dateActiveFrom |
Дата начала активности |
|
dateActiveTo |
Дата окончания активности |
|
previewText |
Описание для анонса |
|
previewTextType |
Тип описания для анонса: |
|
previewPicture |
Идентификатор файла картинки для анонса. Файл можно получить методом catalog.product.download |
|
detailText |
Детальное описание |
|
detailTextType |
Тип детального описания: |
|
detailPicture |
Идентификатор файла детальной картинки. Файл можно получить методом catalog.product.download |
|
iblockSectionId |
Идентификатор основного раздела товара |
|
iblockSection |
Массив идентификаторов всех разделов, к которым привязан товар |
|
type |
Тип товара. Список типов возвращает метод catalog.product.type.list. У товара, созданного методом |
|
available |
Доступность для покупки: |
|
bundle |
Признак комплекта: |
|
quantity |
Доступное количество |
|
quantityReserved |
Зарезервированное количество |
|
quantityTrace |
Действующий режим количественного учета: |
|
canBuyZero |
Действующее разрешение покупки при отсутствии товара: |
|
subscribe |
Действующее разрешение подписки на товар: |
|
vatId |
Идентификатор ставки НДС |
|
vatIncluded |
НДС включен в цену: |
|
purchasingPrice |
Закупочная цена |
|
purchasingCurrency |
Валюта закупочной цены |
|
barcodeMulti |
Уникальный штрихкод для каждого экземпляра: |
|
weight |
Вес |
|
length |
Длина |
|
width |
Ширина |
|
height |
Высота |
|
measure |
Идентификатор единицы измерения |
|
recurSchemeLength |
Длина периода оплаты. Используется только в коробочной версии для продажи контента |
|
recurSchemeType |
Единица времени периода оплаты. Используется только в коробочной версии для продажи контента |
|
trialPriceId |
Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента |
|
withoutOrder |
Продление без оформления заказа: |
|
quantityTraceRaw |
Сохраненное значение режима количественного учета: |
|
paymentType |
Тип оплаты. Используется только в коробочной версии для продажи контента |
|
subscribeRaw |
Сохраненное значение разрешения подписки: |
|
canBuyZeroRaw |
Сохраненное значение разрешения покупки при отсутствии товара: |
|
properties |
Значения свойств товара. Ключ — Значение ключа:
Для свойства типа «Файл» в |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта",
"validation": [
{
"message": "Не заполнено обязательное поле \"name\"",
"field": "name"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено обязательное поле "iblockId" |
Передайте |
|
|
Не заполнено обязательное поле "name" |
Передайте |
|
|
Поле "#FIELD#" не доступно к заполнению |
Уберите из |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте объект |
|
|
Iblock Not Found |
Передайте идентификатор существующего инфоблока торгового каталога |
|
|
Неверный тип товара |
Передайте инфоблок каталога товаров, а не каталога вариаций |
|
|
VAT vatId is not exists |
Передайте идентификатор существующей ставки НДС |
|
|
Currency purchasingCurrency is not exists |
Передайте код существующей валюты |
|
|
User createdBy is not exists |
Передайте идентификатор существующего пользователя |
|
|
User modifiedBy is not exists |
Передайте идентификатор существующего пользователя |
|
|
The properties field accepts only the property keys PROPERTY_{id}, unknown keys: #KEYS# |
Передайте в |
|
|
The properties field names one property by several keys: #KEYS# |
Укажите каждое свойство одним ключом, например только |
|
|
Wrong format of field |
Сейчас дату нельзя задать методами REST 3.0. Передайте |
|
|
В поле |
Сейчас дату нельзя задать методами REST 3.0. Передайте |
|
|
В поле |
Передайте целое число |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте в |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте, что у пользователя есть право «Создание товара» и право на изменение элементов инфоблока. Ошибку вызывает и раздел из |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |