Документация по API - Urban-s
1. Category-list - Список категорий
Получение списка категорий. По-умолчанию возвращает самые "верхние" категории. Если указан parentId, то возвращаются только подкатегории указанной категории.
http://urban-s.ru/api/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 |
Текст ошибки, в случае запроса с ошибкой |
2. Product-list - Список продуктов
Получение списка продуктов. Возвращает данные порциями.
http://urban-s.ru/api/product/list
Параметры
| Название | Тип | Описание |
|---|---|---|
| accessToken необязательный | String |
Токен доступа. |
| offset необязательный | Integer |
Количество уже загруженных записей. |
| pageLimit необязательный | Integer |
Количество товаров на странице. Значение "-1" выведет все товары. |
| priceType необязательный | Integer |
Тип Цены для фильтрации по цене товаров (1 - опт, 2 - мелкий опт, 3 - розница). |
| categoryId необязательный | Integer |
Категория товара. |
| fromPrice необязательный | Number |
Цена товара от этого значения. |
| toPrice необязательный | Number |
Цена товара до этого значения. |
| sortType необязательный | Integer |
Тип сортировки (сначала: по умолчанию - [1], по цене, убывание - [2], по цене, возрастание - [3]). |
| searchString необязательный | String |
Поисковая строка для фильтрации товаров по названию. |
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 |
Максимальный размер |
| priceWholesale | Number |
Цена продукта опт. |
| price | Number |
Цена продукта розница. |
| oldPrice необязательный | Number |
Старая цена продукта розница. |
| colorSelection | Boolean |
Возможность выбора цвета |
| categoriesIds | Integer[] |
Массив ID категорий, в которых показывается товар |
3. Product - Информация о продукте
Получение детальной информации о продукте.
http://urban-s.ru/api/product/get
Параметр
| Название | Тип | Описание |
|---|---|---|
| productId необязательный | Integer |
ID продукта. |
| accessToken необязательный | String |
Токен доступа. |
Success 200
| Название | Тип | Описание |
|---|---|---|
| product | Object |
Объекты с типом данных Product. |
| productId | Integer |
ID продукта. |
| url необязательный | String |
ссылка на товар |
| title | String |
Название продукта. |
| categoriesIds | Integer[] |
Массив ID категорий, в которых показывается товар |
| labels | String[] |
Индикаторы ("NEW", "SALE", "FAMILY_LOOK", "DISCOUNT") |
| composition | String |
Состав |
| priceWholesale | Number |
Цена продукта опт. |
| price | Number |
Цена продукта розница. |
| oldPrice необязательный | Number |
Старая цена продукта розница. |
| minSize | Integer |
Минимальный размер |
| maxSize | Integer |
Максимальный размер |
| imageUrl необязательный | String |
Абсолютный url до первой картинки продукта. |
| descriptionText | String |
Описание товара. |
| images необязательный | Object[] |
Список фотографий продукта |
| url | String |
Абсолютный url до фотографий. |
| previewUrl | String |
Абсолютный url до превью фотографий. |
| title | String |
название вещи |
| colorSelection | Boolean |
Возможность выбора цвета |
| colors | Object[] |
Объекты с типом данных Color. |
| colorId | Integer |
ID цвета. |
| title | String |
отображаемый текст. |
| sizes | Object[] |
Объекты с типом данных Size. |
| sizeId | Integer |
ID размера. |
| title | String |
отображаемый текст. |
4. Sizes-list - Список размеров
Получение списка активных размеров.
http://urban-s.ru/api/sizes/list
Success 200
| Название | Тип | Описание |
|---|---|---|
| data | Object |
Результаты выполнения запроса |
| sizes | Sizes[] |
Объект с сущностями sizes |
| sizeId | Integer |
ID размера |
| title | String |
Название размера |