Типы данных и структура объектов в REST API Каталога

Тип

Описания и значения

catalog_catalog.id

Целочисленный идентификатор торгового каталога (например, 1). Получить идентификаторы торговых каталогов можно с помощью метода catalog.catalog.list

catalog_document.id

Целочисленный идентификатор документа складского учета, например 1. Получить идентификаторы документов можно с помощью метода catalog.document.list

catalog_document_element.id

Целочисленный идентификатор товара документа складского учета, например 1. Получить идентификаторы товаров в документах можно с помощью метода catalog.document.element.list

catalog_documentcontractor.id

Целочисленный идентификатор привязки поставщика к документу складского учета, например 1. Получить идентификаторы привязок можно с помощью метода catalog.documentcontractor.list

catalog_product.id

Целочисленный идентификатор товара (например, 1). Получить идентификаторы товаров можно с помощью метода catalog.product.list

catalog_product_property.id

Целочисленный идентификатор свойства товара или вариации (например, 1). Получить идентификаторы свойств можно с помощью метода catalog.productProperty.list

catalog_product_sku.id

Целочисленный идентификатор головного товара (например, 1). Получить идентификаторы головных товаров можно с помощью метода catalog.product.sku.list

catalog_product_offer.id

Целочисленный идентификатор вариации товара (например, 1). Получить идентификаторы вариаций товаров можно с помощью метода catalog.product.offer.list

catalog_product_service.id

Целочисленный идентификатор услуги (например, 1). Получить идентификаторы услуг можно с помощью метода catalog.product.service.list

catalog_product_image.id

Целочисленный идентификатор изображения товара (например, 1). Получить идентификаторы изображений товаров можно с помощью метода catalog.productImage.list

catalog_store.id

Целочисленный идентификатор склада (например, 1). Получить идентификаторы складов можно с помощью метода catalog.store.list

catalog_measure.id

Целочисленный идентификатор единицы измерения (например, 1). Получить идентификаторы единиц измерения можно с помощью метода catalog.measure.list

catalog_ratio.id

Целочисленный идентификатор коэффициента единицы измерения (например, 1). Получить идентификаторы коэффициентов единиц измерения можно с помощью метода catalog.ratio.list

catalog_price.id

Целочисленный идентификатор цены, например 1. Получить идентификаторы цен можно с помощью метода catalog.price.list

catalog_price_type.id

Целочисленный идентификатор типа цены (например, 1). Получить идентификаторы типов цены можно с помощью метода catalog.priceType.list

catalog_price_type_lang.id

Целочисленный идентификатор перевода названий типов цен (например, 1). Получить идентификаторы переводов можно с помощью метода catalog.priceTypeLang.list

catalog_language.lid

Строковый идентификатор языка, состоящий из двух символов (например, ru). Получить идентификаторы языков можно с помощью метода catalog.priceTypeLang.getLanguages

catalog_rounding_rule.id

Целочисленный идентификатор правила округления цен (например, 1). Получить идентификаторы правил округления цен можно с помощью метода catalog.roundingRule.list

catalog_extra.id

Целочисленный идентификатор наценки (например, 1). Получить идентификаторы наценок можно с помощью метода catalog.extra.list

catalog_section.id

Целочисленный идентификатор раздела каталога (например, 1). Получить идентификаторы разделов каталога можно с помощью метода catalog.section.list

catalog_storeproduct.id

Целочисленный идентификатор записи остатков товара на складе, например 1. Получить идентификаторы можно с помощью метода catalog.storeproduct.list

catalog_vat.id

Целочисленный идентификатор ставки НДС (например, 1). Получить идентификаторы ставки НДС можно с помощью метода catalog.vat.list

Значение
тип

Описание

id
integer

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

iblockId
integer

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

iblockTypeId
string

Тип информационного блока торгового каталога. Для торговых каталогов CRM имеет постоянное значение CRM_PRODUCT_CATALOG

lid
string

Идентификатор сайта. Имеет постоянное значение s1

name
string

Название торгового каталога

productIblockId
integer

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

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

skuPropertyId
integer

Идентификатор свойства, в котором хранится идентификатор родительского товара. Заполняется только для торгового каталога вариаций.

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

subscription
string

Производится ли продажа контента. Возможные значения:

• Y — да
• N — нет

Параметр используется только в коробочной версии

vatId
catalog_vat.id

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

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

Название
тип

Описание

id
integer

Идентификатор документа складского учета

docType
string

Тип документа. Доступные типы можно получить методом catalog.enum.getStoreDocumentTypes

docNumber
string

Внутренний номер документа. Если не передать, генерируется автоматически

title
string

Название документа

siteId
string

Код сайта, к которому относится документ. По умолчанию — s1

responsibleId
integer

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

createdBy
integer

Идентификатор пользователя, создавшего документ

modifiedBy
integer

Идентификатор пользователя, изменившего документ

status
string

Статус документа:

• N — черновик,
• Y — проведен,
• C — отменен.

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

statusBy
integer

Пользователь, изменивший статус документа

dateStatus
datetime

Дата изменения статуса

dateCreate
datetime

Дата создания документа

dateModify
datetime

Дата последнего изменения документа

dateDocument
datetime

Дата проведения документа

currency
string

Валюта документа

total
double

Общая сумма по товарам документа. Значение рассчитывается автоматически после проведения, но может быть задано вручную

commentary
string

Комментарий к документу

Название
тип

Описание

documentId
catalog_document.id

Идентификатор документа складского учета

documentType
string

Тип документа складского учета

fieldN
mixed

Значение пользовательского поля документа, где N — идентификатор пользовательского поля, например field7097

Значение
тип

Описание

id
integer

Идентификатор товара документа складского учета

docId
catalog_document.id

Идентификатор документа складского учета

elementId
catalog_product.id

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

storeFrom
catalog_store.id

Идентификатор склада-источника. Используется для документов, где требуется списание

storeTo
catalog_store.id

Идентификатор склада-получателя. Используется для документов поступления и перемещения

amount
double

Количество товара

purchasingPrice
double

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

Значение
тип

Описание

id
integer

Идентификатор привязки поставщика к документу складского учета

documentId
catalog_document.id

Идентификатор документа складского учета, к которому привязан поставщик

entityTypeId
integer

Идентификатор типа объекта CRM:
3 — контакт
4 — компания

entityId
integer

Идентификатор поставщика: контакта или компании

Значение
тип

Описание

id
integer

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

iblockId
catalog_catalog.id

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

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

name
string

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

active
string

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

• Y — да
• N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

• Y — да
• N — нет

code
string

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

xmlId
string

Внешний код

barcodeMulti
string

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

• Y — да
• N — нет

bundle
string

Наличие набора. Возможные значения:

• Y — да
• N — нет

canBuyZero
string

Разрешается ли покупка товара при его отсутствии. Возможные значения:

• Y — да
• N — нет

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

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

dateActiveTo
datetime

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

dateCreate
datetime

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

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

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

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

detailTextType
string

Тип детального описания. Возможные значения:

• text — текст
• html — HTML

sort
integer

Сортировка

subscribe
string

Разрешение подписки на товар. Возможные значения:

• Y — да
• N — нет
• D — по умолчанию

vatId
catalog_vat.id

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

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

• Y — да
• N — нет

height
float

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

length
float

Длина товара

weight
float

Вес товара

width
float

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

quantityTrace
string

Режим количественного учета. Возможные значения:

• Y — включен
• N — выключен
• D — по умолчанию

type
integer

Тип товара. Только для чтения. Возможные значения:

• 1 — простой товар

purchasingCurrency
string

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

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

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

purchasingPrice
float

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

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

quantity
float

Количество.

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

quantityReserved
float

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

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

recurSchemeLength
integer

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

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

recurSchemeType
string

Единица времени периода оплаты. Возможные значения:

• H — час
• D — день
• W — неделя
• M — месяц
• Q — квартал
• S — полугодие
• Y — год

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

trialPriceId
integer

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

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

withoutOrder
string

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

• Y — да
• N — нет

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

propertyN
object\|array

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

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены.

valueId всех свойств товара можно получить с помощью методов catalog.product.get и catalog.product.list

Значение
тип

Описание

id
integer

Идентификатор свойства

timestampX
datetime

Дата и время изменения свойства

iblockId
catalog_catalog.id

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

name
string

Название свойства

active
char

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

• Y — да
• N — нет

sort
integer

Индекс сортировки

code
string

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

defaultValue
text

Значение свойства по умолчанию

propertyType
string

Базовый тип свойства. Допустимые значения:

• N — число
• S — строка
• L — список
• F — файл
• E — привязка к элементам
• G — привязка к разделам

userType
string

Пользовательский тип свойства. Значение соответствует указанному propertyType.

Примеры значений:

• DateTime — дата и время
• Money — денежное значение с валютой
• SKU — привязка к вариациям товара
• directory — привязка к справочнику
• employee — привязка к сотруднику
• UserID — привязка к пользователю
• EList — выбор элемента из списка
• EAutocomplete — привязка к элементам с автопоиском
• SectionAuto — привязка к разделам с автопоиском
• HTML — значение в формате HTML
• map_google — координаты и адрес на карте Google
• map_yandex — координаты и адрес на карте Яндекс
• DiskFile — привязка к файлу из Битрикс24.Диск
• ECrm — привязка к элементам CRM
• BoolEnum — чекбокс на базе списка

rowCount
integer

Число строк поля ввода

colCount
integer

Число колонок поля ввода

listType
char

Внешний вид списка

multiple
char

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

• Y — да
• N — нет

xmlId
string

Внешний идентификатор свойства

fileType
string

Разрешенные расширения для свойства типа файл

multipleCnt
integer

Число полей ввода для множественных значений

linkIblockId
catalog_catalog.id

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

Доступные идентификаторы можно получить методом catalog.catalog.list

withDescription
char

Признак хранения описания значения

searchable
char

Признак участия в поиске. Возможные значения:

• Y — да
• N — нет

filtrable
char

Признак участия в фильтрации

isRequired
char

Признак обязательности. Возможные значения:

• Y — да
• N — нет

hint
string

Подсказка для поля

userTypeSettings
object

Объект с настройками пользовательского типа

Значение
тип

Описание

id
integer

Идентификатор значения списочного свойства

propertyId
catalog_product_property.id

Идентификатор свойства товара или вариации

value
string

Значение элемента списка

xmlId
string

Внешний идентификатор значения списка

def
char

Признак значения по умолчанию. Возможные значения:

• Y — по умолчанию
• N — не по умолчанию

sort
integer

Индекс сортировки

Значение
тип

Описание

id
integer

Идентификатор параметра свойства

propertyId
catalog_product_property.id

Идентификатор свойства товара или вариации

moduleId
string

Идентификатор модуля, которому принадлежит параметр свойства

featureId
string

Код параметра свойства

isEnabled
char

Признак активности параметра свойства. Возможные значения:

• Y — включен
• N — выключен

Значение
тип

Описание

iblockId
catalog_catalog.id

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

propertyId
catalog_product_property.id

Идентификатор свойства товара или вариации

sectionId
integer

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

Для общих настроек секций возвращается значение 0

smartFilter
char

Показывать ли свойство в умном фильтре. Возможные значения:

• Y — да
• N — нет

displayType
char

Вид свойства в умном фильтре. Возможные значения:

• F — флажки
• K — радиокнопки
• P — выпадающий список

displayExpanded
char

Показывать ли свойство развернутым в фильтре. Возможные значения:

• Y — да
• N — нет

filterHint
string

Подсказка в умном фильтре для посетителей

Значение
тип

Описание

id
integer

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

iblockId
catalog_catalog.id

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

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

name
string

Наименование головного товара

active
string

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

• Y — да
• N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

• Y — да
• N — нет

code
string

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

xmlId
string

Внешний код

bundle
string

Наличие набора. Возможные значения:

• Y — да
• N — нет

canBuyZero
string

Разрешается ли покупка головного товара при его отсутствии. Возможные значения:

• Y — да
• N — нет

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

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

dateActiveTo
datetime

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

dateCreate
datetime

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

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

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

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

detailTextType
string

Тип детального описания. Возможные значения:

• text — текст
• html — HTML

sort
integer

Сортировка

subscribe
string

Разрешение подписки на головной товар. Возможные значения:

• Y — да
• N — нет
• D — по умолчанию

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

vatId
catalog_vat.id

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

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

• Y — да
• N — нет

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

height
float

Высота головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

length
float

Длина головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

weight
float

Вес головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

width
float

Ширина головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

type
integer

Тип товара. Только для чтения. Возможные значения:

• 3 — головной товар с вариациями
• 6 — головной товар без вариаций

purchasingCurrency
string

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

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

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

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

purchasingPrice
float

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

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

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

quantity
float

Количество.

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

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

propertyN
object\|array

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

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены.

valueId всех свойств головного товара можно получить с помощью методов catalog.product.sku.get и catalog.product.sku.list

Значение
тип

Описание

id
integer

Идентификатор вариации товара

iblockId
catalog_catalog.id

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

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

name
string

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

active
string

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

• Y — да
• N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

• Y — да
• N — нет

code
string

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

xmlId
string

Внешний код

barcodeMulti
string

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

• Y — да
• N — нет

bundle
string

Наличие набора. Возможные значения:

• Y — да
• N — нет

canBuyZero
string

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

• Y — да
• N — нет

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

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

dateActiveTo
datetime

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

dateCreate
datetime

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

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

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

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

detailTextType
string

Тип детального описания. Возможные значения:

• text — текст
• html — HTML

sort
integer

Сортировка

subscribe
string

Разрешение подписки на вариацию товара. Возможные значения:

• Y — да
• N — нет
• D — по умолчанию

vatId
catalog_vat.id

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

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

• Y — да
• N — нет

height
float

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

length
float

Длина товара

weight
float

Вес товара

width
float

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

quantityTrace
string

Режим количественного учета. Возможные значения:

• Y — включен
• N — выключен
• D — по умолчанию

type
integer

Тип товара. Только для чтения. Возможные значения:

• 4 — вариация
• 5 — вариация без товара

purchasingCurrency
string

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

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

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

purchasingPrice
float

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

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

quantity
float

Количество.

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

quantityReserved
float

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

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

recurSchemeLength
integer

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

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

recurSchemeType
string

Единица времени периода оплаты. Возможные значения:

• H — час
• D — день
• W — неделя
• M — месяц
• Q — квартал
• S — полугодие
• Y — год

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

trialPriceId
integer

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

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

withoutOrder
string

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

• Y — да
• N — нет

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

propertyN
object\|array

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

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены.

valueId всех свойств торгового прдложения можно получить с помощью методов catalog.product.offer.get и catalog.product.offer.list

Значение
тип

Описание

id
integer

Идентификатор услуги

iblockId
catalog_catalog.id

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

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

name
string

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

active
string

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

• Y — да
• N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

• Y — да
• N — нет

code
string

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

xmlId
string

Внешний код

bundle
string

Наличие набора. Возможные значения:

• Y — да
• N — нет

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

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

dateActiveTo
datetime

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

dateCreate
datetime

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

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

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

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

detailTextType
string

Тип детального описания. Возможные значения:

• text — текст
• html — HTML

sort
integer

Сортировка

vatId
catalog_vat.id

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

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

• Y — да
• N — нет

type
integer

Тип товара. Только для чтения. Возможные значения:

• 7 — услуга

propertyN
object\|array

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

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены.

valueId всех свойств услуги можно получить с помощью методов catalog.product.service.get и catalog.product.service.list

Значение
тип

Описание

id
integer

Идентификатор изображения

name
string

Наименование изображения

productId
integer

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

type
string

Тип изображения:

• DETAIL_PICTURE — детальная картинка, поле доступно в старой карточке товара
• PREVIEW_PICTURE — картинка для анонса, поле доступно в старой карточке товара
• MORE_PHOTO — картинка

createTime
datetime

Дата создания изображения

downloadUrl
string

Ссылка для скачивания, подписанная текущим токеном доступа

detailUrl
string

Ссылка на изображение

Название
тип

Описание

id
integer

Идентификатор склада

address
string

Адрес склада

title
string

Название склада

active
string

Активность. Возможные значения:

• Y — да
• N — нет

description
string

Описание

gpsN
double

GPS-широта

gpsS
double

GPS-долгота

imageId
object

Изображение. Объект в формате {fileData: [value1, value2]}, где:

• value1 – название файла картинки с расширением
• value2 – картинка в формате base64

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

dateModify
datetime

Дата изменения

dateCreate
datetime

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

userId
user.id

Кем создан

modifiedBy
user.id

Кем изменен

phone
string

Телефон

schedule
string

График работы

xmlId
string

Внешний код.

Можно использовать для синхронизации текущего склада с аналогичной позицией во внешней системе

sort
integer

Сортировка

email
string

E-mail

issuingCenter
string

Является ли пунктом выдачи. Возможные значения:

• Y – да
• N – нет

code
string

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

Значение
тип

Описание

id
integer

Идентификатор единицы измерения

code
integer

Код единицы измерения

isDefault
string

Используется ли текущая единица измерения в качестве единицы измерения по умолчанию для новых товаров. Возможные значения:

• Y — да
• N — нет

Только одна единица измерения из всего справочника может принимать значение Y

measureTitle
string

Название единицы измерения

symbol
string

Условное обозначение

symbolIntl
string

Международное условное обозначение

symbolLetterIntl
string

Международное кодовое буквенное обозначение

Значение
тип

Описание

id
integer

Идентификатор коэффициента единицы измерения

productId
integer

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

ratio
double

Коэффициент единицы измерения

isDefault
string

Является ли данный коэффициент единицы измерения коэффициентом по умолчанию. Возможные значения:

• Y — да
• N — нет

Значение
тип

Описание

id
integer

Идентификатор цены

productId
catalog_product.id

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

catalogGroupId
catalog_price_type.id

Идентификатор типа цены

price
double

Значение цены

priceScale
double

Значение базовой цены

currency
string

Валюта цены

quantityFrom
double

Минимальное количество для применения цены. Устаревший параметр

quantityTo
double

Максимальное количество для применения цены. Устаревший параметр

extraId
catalog_extra.id

Идентификатор наценки. Устаревший параметр

timestampX
datetime

Дата изменения

Значение
тип

Описание

id
integer

Идентификатор типа цены

name
string

Код типа цены

base
string

Является ли тип цены базовым. Возможные значения:

• Y — да
• N — нет

sort
integer

Сортировка

xmlId
string

Внешний код.

Можно использовать для синхронизации текущего типа цены с аналогичной позицией во внешней системе

timestampX
datetime

Дата изменения

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateCreate
datetime

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

Значение
тип

Описание

id
integer

Идентификатор привязки типа цены к группе покупателей

catalogGroupId
catalog_price_type.id

Идентификатор типа цены

groupId
integer

Идентификатор группы покупателей

access
char

Тип доступа. Возможные значения:

• Y — право на покупку по этому типу цены
• N — право на просмотр этого типа цены

Значение
тип

Описание

id
integer | string

Идентификатор элемента перечисления

name
string

Название элемента перечисления

Значение
тип

Описание

id
integer

Идентификатор перевода названия типа цены

catalogGroupId
catalog_price_type.id

Идентификатор типа цены

name
string

Перевод названия типа цены

lang
catalog_language.lid

Идентификатор языка

Значение
тип

Описание

lid
string

Идентификатор языка

name
string

Название языка

active
string

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

• Y — да
• N — нет

Значение
тип

Описание

id
integer

Идентификатор правила округления цен

catalogGroupId
catalog_price_type.id

Тип цены

price
double

Минимальная цена для округления

roundType
integer

Тип округления. Возможные значения:

• 1 — математическое округление
• 2 — округление вверх (в пользу магазина)
• 4 — округление вниз (в пользу клиента)

roundPrecision
double

Точность округления

createdBy
user.id

Кем создано

modifiedBy
user.id

Кем изменено

dateCreate
datetime

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

dateModify
datetime

Дата изменения

Значение
тип

Описание

id
integer

Идентификатор наценки

name
string

Название наценки

percentage
double

Величина наценки

Значение
тип

Описание

id
integer

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

iblockId
catalog_catalog.id

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

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

iblockSectionId
catalog_section.id

Идентификатор родительского раздела.

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

По умолчанию выбирается верхний уровень

name
string

Название раздела каталога

xmlId
string

Внешний идентификатор.

Можно использовать для синхронизации текущего раздела каталога с аналогичной позицией во внешней системе

code
string

Код раздела каталога

sort
integer

Сортировка

active
string

Индикатор активности раздела каталога:

• Y — активен
• N — неактивен

description
string

Описание

descriptionType
string

Тип описания. Доступные типы: text, html

Значение
тип

Описание

id
integer

Идентификатор записи остатка

productId
catalog_product.id

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

storeId
catalog_store.id

Идентификатор склада

amount
double

Доступное количество товара

quantityReserved
double

Количество товара в резерве

Значение
тип

Описание

id
integer

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

name
string

Название ставки НДС

active
string

Индикатор активности ставки НДС. Возможные значения:

• Y — активен
• N — неактивен

rate
double

Величина ставки НДС

sort
integer

Сортировка

timestampX
datetime

Время последнего изменения

Значение
тип

Описание

isImmutable
boolean

Индикатор возможности изменения значения поля после создания.

Если у поля выставлен данный индикатор, то при создании объекта можно указать значение поля, но изменить его при обновлении не получится

isReadOnly
boolean

Индикатор «только чтение».

Если у поля выставлен данный индикатор, то в операциях добавления и обновления объекта передавать значение поля не нужно. Значение формируется автоматически и предназначено только для чтения

isRequired
boolean

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

type
string

Тип данных значений поля. Возможные значения:

• integer
• double
• string
• char
• list
• text
• file
• date
• datetime
• datatype
• productpropertysettings