метод REST scope: catalog

catalog.product.service.add

Добавить услугу

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

Описание

Метод добавляет услугу в торговый каталог.

Параметры

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

Значения полей для добавления услуги

Параметр fields

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

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

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

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

Наименование услуги

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

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

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

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

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

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

Внешний код

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 необязательный

Сортировка

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

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

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

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

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

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

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

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

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":23,"name":"Услуга","active":"Y","code":"service","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","iblockSectionId":47,"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","sort":100,"vatId":1,"vatIncluded":"Y","xmlId":"","property258":"test","property259":["test1","test2"]}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.service.add

Ответ

HTTP-статус: 200

{
    "result": {
        "service": {
            "active": "Y",
            "available": "N",
            "bundle": "N",
            "code": "service",
            "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": "6495",
                "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6495\u0026fields%5BproductId%5D=1264",
                "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6495\u0026fields%5BproductId%5D=1264"
            },
            "detailText": null,
            "detailTextType": "text",
            "iblockId": 23,
            "iblockSectionId": 47,
            "id": 1264,
            "modifiedBy": 1,
            "name": "Услуга",
            "previewPicture": {
                "id": "6494",
                "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6494\u0026fields%5BproductId%5D=1264",
                "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6494\u0026fields%5BproductId%5D=1264"
            },
            "previewText": null,
            "previewTextType": "text",
            "property258": {
                "value": "test",
                "valueId": "9806"
            },
            "property259": [
                {
                    "value": "test1",
                    "valueId": "9807"
                },
                {
                    "value": "test2",
                    "valueId": "9808"
                }
            ],
            "sort": 100,
            "timestampX": "2024-06-14T11:51:08+03:00",
            "type": 7,
            "vatId": 1,
            "vatIncluded": "Y",
            "xmlId": "1264"
        }
    },
    "time": {
        "start": 1718362267.704109,
        "finish": 1718362268.795468,
        "duration": 1.0913591384887695,
        "processing": 0.676487922668457,
        "date_start": "2024-06-14T13:51:07+03:00",
        "date_finish": "2024-06-14T13:51:08+03:00"
    }
}

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

result object

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

service catalog_product_service

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

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 Другие ошибки (например, фатальные ошибки)

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

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