Товар является иерархической сущностью. При получении товара передаётся информация о самом товаре, всех его разновидностях и значениях, которые указаны отдельно для каждой разновидности.
Поля объекта product
| Тип | Название | Описание |
|---|---|---|
| string | id | Идентификатор товара или услуги |
| integer | type | Тип объекта: 1 — товар, 2 — услуга |
| string | name | Название товара или услуги |
| string | article | Артикул |
| string | description | Текстовое описание |
| string? | sectionId | Идентификатор раздела каталога |
| decimal | price | Цена продажи |
| decimal | purchasePrice | Закупочная цена |
| decimal | weight | Вес |
| decimal | volume | Объём |
| integer | vat | Ставка НДС: -1 — без НДС, 0 — 0%, 10 — 10%, 20 — 20% |
| int? | unitId | Идентификатор единицы измерения |
| string | currencyId | Идентификатор валюты |
| boolean | inheritedPhotos | Показывает, унаследованы ли фотографии из раздела каталога |
| boolean | archive | Показывает, находится ли товар или услуга в архиве |
| decimal? | discountPercent | Процент скидки |
| array (photo) | photos | Фотографии товара или услуги |
| array (productChar) | chars | Характеристики товара или услуги |
| array (child) | children | Разновидности товара или услуги — дочерние товары |
| array (productionMaterial) | productionMaterials | Материалы, используемые для производства товара |
| integer | syncStatus | Статус синхронизации объекта: 1 — изменён, 2 — синхронизирован |
| integer | version | Версия данных |
Объект фотографии — photo
| Тип | Название | Описание |
|---|---|---|
| string | id | Идентификатор фотографии |
| string | link | Ссылка на фотографию |
Объект разновидности товара — child
Объект содержит информацию о разновидности товара или услуги. Разновидности могут иметь собственные значения цены, закупочной цены, веса, объёма, скидки, фотографий, характеристик и материалов производства.
Если значение одного из nullable-полей не указано у разновидности, оно может наследоваться от родительского товара.
| Тип | Название | Описание |
|---|---|---|
| string | id | Идентификатор разновидности товара или услуги |
| string | name | Название |
| string | article | Артикул |
| string | description | Текстовое описание |
| decimal? | price | Цена продажи |
| decimal? | purchasePrice | Закупочная цена |
| decimal? | weight | Вес |
| decimal? | volume | Объём |
| decimal? | discountPercent | Процент скидки |
| object (productOption) | option | Опция и выбранное значение опции |
| array (photo) | photos | Фотографии разновидности |
| array (productChar) | chars | Характеристики разновидности |
| array (child) | children | Дочерние разновидности следующего уровня |
| array (productionMaterial) | productionMaterials | Материалы, используемые для производства разновидности товара |
Объект опции разновидности — productOption
Объект содержит информацию об опции, по которой сформирована разновидность товара.
Например:
- опция — «Цвет»;
- значение опции — «Красный».
| Тип | Название | Описание |
|---|---|---|
| string | optionId | Идентификатор опции |
| string | optionName | Название опции |
| string? | optionValueId | Идентификатор значения опции |
| string | optionValue | Значение опции |
Объект характеристики — productChar
| Тип | Название | Описание |
|---|---|---|
| string | charId | Идентификатор характеристики |
| string | charName | Название характеристики |
| string? | charValueId | Идентификатор значения характеристики. Используется для характеристик со значениями из списка |
| string | charValue | Значение характеристики |
Объект материала производства — productionMaterial
Объект содержит информацию о товаре или материале, который используется для производства основного товара или его разновидности.
| Тип | Название | Описание |
|---|---|---|
| string | id | Идентификатор материала |
| string | article | Артикул материала или товара |
| decimal | quantity | Количество материала, необходимое для производства |