метод REST scope: catalog

catalog.product.offer.add

Добавить вариацию товара

Кто может выполнять: администратор

Описание

Метод добавляет вариацию товара в торговый каталог.

Параметры

fields object обязательный

Значения полей для добавления вариации товара

Параметр fields

iblockId catalog_catalog.id обязательный

Идентификатор информационного блока торгового каталога для вариаций.

Для получения существующих идентификаторов информационных блоков торговых каталогов необходимо использовать catalog.catalog.list. У инфоблока вариаций заполнено поле productIblockId

name string обязательный

Наименование вариации товара

active string необязательный

Признак активности. Возможные значения:
- Y — да
- N — нет

По умолчанию устанавливается Y

code string необязательный

Символьный код

xmlId string необязательный

Внешний код

barcodeMulti string необязательный

Уникальные штрихкоды для каждого экземпляра. Возможные значения:
- Y — да
- N — нет

По умолчанию устанавливается N

canBuyZero string необязательный

Разрешается ли покупка вариации товара при ее отсутствии. Возможные значения:
- Y — да
- N — нет

По умолчанию устанавливается N

createdBy user.id необязательный

Кем создан

modifiedBy user.id необязательный

Кем изменен

dateActiveFrom datetime необязательный

Дата начала активности

dateActiveTo datetime необязательный

Дата окончания активности

dateCreate datetime необязательный

Дата создания

iblockSectionId catalog_section.id необязательный

Идентификатор основного раздела информационного блока

IblockSection array необязательный

Массив со всеми разделами, к которым привязана вариация товара

measure catalog_measure.id необязательный

Единица измерения

previewText string необязательный

Описание для анонса

detailText string необязательный

Детальное описание

previewPicture object необязательный

Картинка для анонса. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: 'Y'}

detailPicture object необязательный

Детальная картинка. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: 'Y'}

previewTextType string необязательный

Тип описания для анонса. Возможные значения:
- text — текст
- html — HTML

По умолчанию устанавливается text

detailTextType string необязательный

Тип детального описания. Возможные значения:
- text — текст
- html — HTML

По умолчанию устанавливается text

sort integer необязательный

Сортировка

subscribe string необязательный

Разрешение подписки на вариацию товара. Возможные значения:
- Y — да
- N — нет
- D — по умолчанию

По умолчанию устанавливается D

vatId catalog_vat.id необязательный

Идентификатор НДС

vatIncluded string необязательный

Включен ли НДС в цену. Возможные значения:
- Y — да
- N — нет

По умолчанию устанавливается N

height double необязательный

Высота вариации товара

length double необязательный

Длина вариации товара

weight double необязательный

Вес вариации товара

width double необязательный

Ширина вариации товара

quantityTrace string необязательный

Режим количественного учета. Возможные значения:
- Y — включен
- N — выключен
- D — по умолчанию

По умолчанию устанавливается D

purchasingCurrency string необязательный

Валюта закупочной цены.

Список валют можно получить методом crm.currency.list.

Не редактируется при включенном складском учете

purchasingPrice double необязательный

Закупочная цена.

Не редактируется при включенном складском учете

quantity double необязательный

Количество.

Не редактируется при включенном складском учете

quantityReserved double необязательный

Зарезервированное количество.

Не редактируется при включенном складском учете

recurSchemeLength integer необязательный

Длина периода оплаты.

По умолчанию устанавливается 0.

Используется только в коробочной версии для продажи контента

recurSchemeType string необязательный

Единица времени периода оплаты. Возможные значения:
- H — час
- D — день
- W — неделя
- M — месяц
- Q — квартал
- S — полугодие
- Y — год

По умолчанию устанавливается D.

Используется только в коробочной версии для продажи контента

trialPriceId integer необязательный

Товар для пробной оплаты.

Используется только в коробочной версии для продажи контента

withoutOrder string необязательный

Продление без оформления заказа. Возможные значения:
- Y — да
- N — нет

По умолчанию устанавливается N.

Используется только в коробочной версии для продажи контента

parentId integer необязательный

Идентификатор головного товара.

Для получения идентификаторов головных товаров необходимо использовать catalog.product.sku.list

propertyN any необязательный

Значение свойства вариации товара, где N — идентификатор свойства. Свойств может быть несколько.

При добавлении вариации товара значение свойства можно указать строкой, числом, а также в виде объекта {value: value}. Если свойство множественное, то указывается массив из значений либо объектов вида {value: value}

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":24,"name":"Вариация товара","active":"Y","barcodeMulti":"Y","canBuyZero":"Y","code":"Tovar","createdBy":1,"dateActiveFrom":"2024-05-28T10:00:00","dateActiveTo":"2024-05-29T10:00:00","dateCreate":"2024-05-27T10:00:00","detailPicture":{"fileData":["detailPicture.png","iVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BMVEX37ff/­///58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7EAAAOxAGV­Kw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCocSfQFGKP3­+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA/q2TwrXZ­ib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt3qSQtwdJ­Ssku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+28tICq4rT­qXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQEFhV3CCN­Tph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKrihqje7Y9­iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guvayybW1i3­Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWtJSyP21r+­FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0hPtw86hMX­99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xfAAAAAElF­TkSuQmCCiVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BM­VEX37ff////58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7E­AAAOxAGVKw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCoc­SfQFGKP3+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA­/q2TwrXZib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt­3qSQtwdJSsku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+2­8tICq4rTqXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQ­EFhV3CCNTph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKr­ihqje7Y9iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guv­ayybW1i3Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWt­JSyP21r+FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0h­Ptw86hMX99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xf­AAAAAElFTkSuQmCC"]},"detailText":"","detailTextType":"text","height":100,"iblockSectionId":47,"length":100,"measure":5,"modifiedBy":1,"previewPicture":{"fileData":["previewPicture.png","iVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BMVEX37ff/­///58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7EAAAOxAGV­Kw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCocSfQFGKP3­+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA/q2TwrXZ­ib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt3qSQtwdJ­Ssku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+28tICq4rT­qXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQEFhV3CCN­Tph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKrihqje7Y9­iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guvayybW1i3­Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWtJSyP21r+­FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0hPtw86hMX­99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xfAAAAAElF­TkSuQmCCiVBORw0KGgoAAAANSUhEUgAAAMgAAADIBAMAAABfdrOtAAAAG1BM­VEX37ff////58fn9+v3+/P779vv8+Pz47/j68/oDfe+3AAAACXBIWXMAAA7E­AAAOxAGVKw4bAAABrUlEQVR4nO3UT0/CMBjH8ccx2I56IFynkHg1SgxHHCoc­SfQFGKP3+e++xL1wn7bPUCAeKF5Mvp+EluX3ZN3ariIAAAAAAAAAAAAAAAAA­/q2TwrXZib94LTbj5GdgVbtKxhdXS+2uL270ajQbL9fz4WzcXwVWtbNeIdmt­3qSQtwdJSsku1/NHkfdVEKriHFey0G4haS3+ty4ZtEGoipMW+VS7T2m0zc+2­8tICq4rTqXtuJV7kWdvsUJtuoc1Hm08ssKo4B1Wn1i6tJu5qrj9dA8lWEzOQ­EFhV3CCNTph2naJ0V+eu0SV+ry3WWQqBVcUNsgiP16ndS4SnzuffL5LWEgKr­ihqje7Y9iDTN6mZ38geDNNX2dEm338b5XPafrmRuj/dj4fULfGoXeFTJ/guv­ayybW1i3Vl7aM7h+3y2c+y07FfeZjaT9GHVrNYXPG/fkIbCqCPf+9d1WKiWt­JSyP21r+FaTrZ8+CULW7XliCUe0PyIUdkD29qQzdv7A0FoSq3R0fqaU78d0h­Ptw86hMX99vAqqJlp757/W3vhMCqAAAAAAAAAAAAAAAAAPxbX82/SILlk9xf­AAAAAElFTkSuQmCC"]},"previewText":"","previewTextType":"text","purchasingCurrency":"RUB","purchasingPrice":1000,"quantity":10,"quantityReserved":1,"quantityTrace":"Y","recurSchemeLength":1,"recurSchemeType":"D","sort":100,"subscribe":"Y","trialPriceId":175,"vatId":1,"vatIncluded":"Y","weight":100,"width":100,"withoutOrder":"Y","xmlId":"","parentId":1275,"property258":"test","property259":["test1","test2"]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.offer.add

Ответ

HTTP-статус: 200

{
    "result": {
        "offer": {
            "active": "Y",
            "available": "Y",
            "bundle": "N",
            "canBuyZero": "Y",
            "code": "Tovar",
            "createdBy": 1,
            "dateActiveFrom": "2024-05-28T10:00:00+03:00",
            "dateActiveTo": "2024-05-29T10:00:00+03:00",
            "dateCreate": "2024-05-27T10:00:00+03:00",
            "detailPicture": {
                "id": "6536",
                "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6536\u0026fields%5BproductId%5D=1285",
                "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6536\u0026fields%5BproductId%5D=1285"
            },
            "detailText": null,
            "detailTextType": "text",
            "height": 100,
            "iblockId": 24,
            "iblockSectionId": null,
            "id": 1285,
            "length": 100,
            "measure": 5,
            "modifiedBy": 1,
            "name": "Вариация товара",
            "parentId": {
                "value": "1275",
                "valueId": "9863"
            },
            "previewPicture": {
                "id": "6535",
                "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6535\u0026fields%5BproductId%5D=1285",
                "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6535\u0026fields%5BproductId%5D=1285"
            },
            "previewText": null,
            "previewTextType": "text",
            "property261": {
                "value": "test",
                "valueId": "9864"
            },
            "property262": [
                {
                    "value": "test1",
                    "valueId": "9865"
                },
                {
                    "value": "test2",
                    "valueId": "9866"
                }
            ],
            "purchasingCurrency": "RUB",
            "purchasingPrice": "1000.000000",
            "quantity": 10,
            "quantityReserved": 1,
            "quantityTrace": "Y",
            "sort": 100,
            "subscribe": "Y",
            "timestampX": "2024-06-17T12:25:48+03:00",
            "type": 4,
            "vatId": 1,
            "vatIncluded": "Y",
            "weight": 100,
            "width": 100,
            "xmlId": "1285"
        }
    },
    "time": {
        "start": 1718623548.268628,
        "finish": 1718623549.235369,
        "duration": 0.9667410850524902,
        "processing": 0.559999942779541,
        "date_start": "2024-06-17T14:25:48+03:00",
        "date_finish": "2024-06-17T14:25:49+03:00"
    }
}

Возвращаемые данные

result object

Корневой элемент ответа

offer catalog_product_offer

Объект с информацией о добавленной вариации товара

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":200040300010,
    "error_description":"Access Denied"
}
Код Описание Значение
200040300050 Недостаточно прав для привязки элемента информационного блока к разделу
200040300040 Недостаточно прав для создания вариации товара
200040300000 Информационный блок с указанным идентификатором не существует
200040300043 Недостаточно прав для редактирования элемента информационного блока
200040300010 Недостаточно прав для чтения торгового каталога
100 Не указан или пустой параметр fields
0 Раздел с указанным идентификатором не существует
0 Ставка НДС с указанным идентификатором не существует
0 Указанная валюта закупочной цены не существует
0 Пользователь с указанным идентификатором, создавший вариацию товара, не существует
0 Пользователь с указанным идентификатором, изменивший вариацию товара, не существует
0 Не переданы обязательные поля
0 Вариация товара с указанным символьным кодом уже существует
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.