Ограничение на количество запросов
Существует ограничение на количество запросов к серверу по API за одну секунду. В случае превышения Вы получите ответ
{ "data": [], "meta": { "success": false, "error": "Rate limit exceeded.", "code": 429 } }
Category - Получение списка категорий
Получение списка категорий. По-умолчанию возвращает самые "верхние" категории. Если указан parentId, то возвращаются только подкатегории указанной категории.
https://api.natali.ru/category/list
Параметр
| Название | Тип | Описание |
|---|---|---|
| parentId необязательный | String |
ID родительской категории. |
Success 200
| Название | Тип | Описание |
|---|---|---|
| data | Object |
Результаты выполнения запроса |
| categories | Category[] |
Объект с сущностями category. |
| hasSubcategories | Boolean |
Индикатор наличия у указанной категории подкатегорий. |
| categoryId | Integer |
ID категории. |
| title | String |
Название. |
Meta
| Название | Тип | Описание |
|---|---|---|
| meta | Object |
Раздел с мета данными |
| success | Boolean |
Индикация успешного выполнения запроса или запроса с ошибкой |
| error | String |
Текст ошибки, в случае запроса с ошибкой |
Product - Получение списка продуктов.
Получение списка продуктов. Возвращает данные порциями.
https://api.natali.ru/product/list
Параметр
| Название | Тип | Описание |
|---|---|---|
| accessToken необязательный | String |
Токен доступа. |
| offset необязательный | Integer |
Номер страницы, если указан offset, вычисляется как ceil(offset/9) + 1 |
| pageLimit необязательный | Integer |
Количество товаров на странице. |
| priceType необязательный | Integer |
Тип Цены для фильтрации по цене товаров (1 - опт, 2 - мелкий опт, 3 - розница). |
| categoryId необязательный | Integer |
Категория товара. |
| fromPrice необязательный | Number |
Цена товара от этого значения. |
| toPrice необязательный | Number |
Цена товара до этого значения. |
| fromSize необязательный | Integer |
Размер товара от этого значения. |
| toSize необязательный | Integer |
Размер товара до этого значения. |
| sortType необязательный | Integer |
Тип сортировки (сначала: по умолчанию - [1], по цене, убывание - [2], по цене, возрастание - [3]). |
| materials необязательный | Integer[] |
Тип ткани |
| searchOptions необязательный | Integer[] |
Опции поиска |
| searchString необязательный | String |
Поисковая строка для фильтрации товаров по названию. |
| favouritesOnly необязательный | Booblean |
Позволяет указать, что нужно вернуть только избранные товары для данного пользователя. Если не указан, то по-умолчанию false. Обрабатывается, только если передан параметр accessToken |
Success 200
| Название | Тип | Описание |
|---|---|---|
| products | Object[] |
Объекты с типом данных Product. |
| productId | Integer |
ID продукта. |
| imageUrl необязательный | String |
Абсолютный путь до первой иконки продукта. |
| previewImageUrl необязательный | String |
Абсолютный путь до превью первой иконки продукта. |
| labels | String[] |
Индикаторы ("NEW", "SALE", "FAMILY_LOOK", "DISCOUNT") |
| title | String |
Название продукта. |
| minSize | Integer |
Минимальный размер |
| maxSize | Integer |
Максимальный размер |
| colorsCount | Integer |
Количество вариантов цветов в продукте. |
| priceWholesale | Number |
Цена продукта опт. |
| priceSmallWholesale | Number |
Цена продукта мелкий опт. |
| price | Number |
Цена продукта розница. |
| oldPriceWholesale необязательный | Number |
Старая цена продукта опт. |
| oldPriceSmallWholesale необязательный | Number |
Старая цена продукта мелкий опт. |
| oldPrice необязательный | Number |
Старая цена продукта розница. |
| isDressingRoomAvailable | Boolean |
Доступен ли товар для добавления в примерочную |
| colorSelection | Boolean |
Возможность выбора цвета |
| categoriesIds | Integer[] |
Массив ID категорий, в которых показывается товар |
| containVideo | Boolean |
Содержит ли видео? |
| isMarked | Boolean |
Маркированный ли это товар? |
| isWithoutVat | Boolean |
Товар продаётся без НДС? |
| type | Integer |
Вид изделия |
| labels | String[] |
Массив меток товара |
| labelsIds | Integer[] |
Массив ID меток товара |
| total | Number |
Количество найденных товаров. |
Product - Получение деталей продукта.
Получение детальной информации о продукте.
https://api.natali.ru/product/get
Параметр
| Название | Тип | Описание |
|---|---|---|
| productId | Integer |
ID продукта. |
| accessToken необязательный | String |
Токен доступа. |
Success 200
| Название | Тип | Описание |
|---|---|---|
| product | Object |
Объекты с типом данных Product. |
| productId | Integer |
ID продукта. |
| url необязательный | String |
ссылка на товар |
| title | String |
Название продукта. |
| isDressingRoomAvailable | Boolean |
Доступен ли товар для добавления в примерочную. |
| isAlreadyInDressingRoom | Boolean |
товар уже в примерочной. |
| categoriesIds | Integer[] |
Массив ID категорий, в которых показывается товар |
| labels | String[] |
Индикаторы ("NEW", "SALE", "FAMILY_LOOK", "DISCOUNT") |
| containVideo | Boolean |
Содержит ли видео? |
| isMarked | Boolean |
Маркированный ли это товар? |
| isWithoutVat | Boolean |
Товар продаётся без НДС? |
| type | Integer |
Вид изделия |
| materials | Object[] |
Список тканей товара |
| materialId | Integer |
ID ткани |
| title | String |
Название ткани |
| materialDescription необязательный | String |
Описание ткани |
| composition | String |
Состав |
| priceWholesale | Number |
Цена продукта опт. |
| priceSmallWholesale | Number |
Цена продукта мелкий опт. |
| price | Number |
Цена продукта розница. |
| oldPriceWholesale необязательный | Number |
Старая цена продукта опт. |
| oldPriceSmallWholesale необязательный | Number |
Старая цена продукта мелкий опт. |
| oldPrice необязательный | Number |
Старая цена продукта розница. |
| isFavorite необязательный | Boolean |
Индикация, находится ли данный товар в избранном у пользователя, или нет. Возвращается, только если передан параметр accessToken |
| minSize | Integer |
Минимальный размер |
| maxSize | Integer |
Максимальный размер |
| brandId необязательный | Integer |
ID бренда. См. "Получение списка брендов" |
| imageUrl необязательный | String |
Абсолютный url до первой картинки продукта. |
| descriptionText | String |
Описание товара. |
| characteristics | String |
Характеристики товара. |
| images необязательный | Object[] |
Список фотографий продукта |
| colorId необязательный | Integer |
ID цвета, если картинка привязана к какому-либо цвету |
| url | String |
Абсолютный url до фотографий. |
| previewUrl | String |
Абсолютный url до превью фотографий. |
| videosнеобязательный | Object[] |
Список видео продукта |
| garments необязательный | Object[] |
Комплектность (список вещей) |
| title | String |
название вещи |
| dimensions | Object[] |
замеры |
| size | String |
размер |
| item | Object[] |
элемент замера |
| title | String |
название замера |
| value | Integer |
значение замера |
| colorSelection | Boolean |
Возможность выбора цвета |
| colors | Object[] |
Объекты с типом данных Color. |
| colorId | Integer |
ID цвета. |
| title | String |
отображаемый текст. |
| sizes | Object[] |
Объекты с типом данных Size. |
| sizeId | Integer |
ID размера. |
| title | String |
отображаемый текст. |
| weight | Number |
вес товара. |
| priceWholesale | Number |
оптовая цена размера |
| priceSmallWholesale | Number |
мелкооптовая цена размера |
| price | Number |
розничная цена размера |
| ean | Number |
штрихкод |
| onlyPack | Boolean |
Продается только упаковками |
| inPack | Integer |
Количество в упаковке |
Product - Получение списка изменённых продуктов
Получение списка изменённых продуктов
https://api.natali.ru/product/changes
Параметр
| Название | Тип | Описание |
|---|---|---|
| accessToken необязательный | String |
Токен доступа. |
| from необязательный | Date/Time |
Диапазон времени "от" в формате Y-m-d H:m:s |
| to необязательный | Date/Time |
Диапазон времени "до" в формате Y-m-d H:m:s |
| type необязательный | String |
Вывести продукты с определённым типом изменения: 'published' (опубликован), 'unpublished' (снят с продажи) или 'modify' . Если не указан, то будут возвращены все три типа изменений |
Success 200
| Название | Тип | Описание |
|---|---|---|
| Object |
Массивы с продуктами с изменениями определённых типов |
|
| product_id | Integer |
ID продукта. |
| last_modify | Date/Time |
Дата/время последнего изменения продукта |
Sizes - Получение списка размеров
Получение списка активных размеров.
https://api.natali.ru/sizes/list
Success 200
| Название | Тип | Описание |
|---|---|---|
| data | Object |
Результаты выполнения запроса |
| sizes | Sizes[] |
Объект с сущностями sizes |
| sizeId | Integer |
ID размера |
| title | String |
Название размера |
Colors - Получение списка расцветок
Получение списка активных расцветок.
https://api.natali.ru/colors/list
Success 200
| Название | Тип | Описание |
|---|---|---|
| data | Object |
Результаты выполнения запроса |
| colors | Colors[] |
Объект с сущностями colors |
| colorId | Integer |
ID расцветки |
| title | String |
Название расцветки |
Brands - Получение списка брендов
Получение списка активных брендов.
https://api.natali.ru/brand/list
Success 200
| Название | Тип | Описание |
|---|---|---|
| data | Object |
Результаты выполнения запроса |
| brands | Brands[] |
Объект с сущностями brands |
| id | Integer |
ID бренда |
| image | String |
Полный путь к логотипу бренда |
| title | String |
Название бренда |
Product-types - Получение списка видов продуктов
Получение списка видов продуктов.
https://api.natali.ru/product-type/list
Success 200
| Название | Тип | Описание |
|---|---|---|
| data | Object |
Результаты выполнения запроса |
| items | Types[] |
Объект с сущностями types |
| id | Integer |
ID вида продукта |
| title | String |
Название вида продукта |