# Формат запроса

```
https://api.oasiscatalog.com/v4/products?format=json&limit=1
```

<https://api.oasiscatalog.com/v4> - основной url

## GET-параметры

### Отображение данных:

* **download** - параметр, отвечает за получения выгрузки в виде файла
* **format** - параметр, формат выгрузки
* **currency** - параметр, указывающий валюту, в которой нужно выводить цены (дефолт: RUB)
* **fieldset** - параметр, набор полей*basic*или*full*. Набор basic позволяет сохранить совместимость с yandex market (дефолт: basic)
* **fields** - параметр, позволяет вывести определенные поля в выгрузке
* **separator** - параметр, указывающий какой символ нужно использовать для разделения полей в CSV файле (дефолт: `,`)
* **values\_separator** - параметр, указывающий какой символ нужно использовать для разделения множественных значений в поле в CSV файле (дефолт: `;`)
* **no\_vat** - параметр, указывающий необходимость расчета цены с учетом НДС или без учета

### Фильтрация данных:

* **limit** - параметр, вводит ограничение в виде выгружаемого количества товаров
* **offset** - параметр, позволяет указать с какого элемента выгружать данные
* **category** - параметр, указывающий ID категорий, из которых нужно выводить товары (перечислять через запятую)
* **ids** - параметр, указывающий ID товаров, которые нужно вывести (перечислять через запятую)
* **articles** - параметр, указывающий артикулы товаров, которые нужно вывести (перечислять через запятую)
* **rating** - параметр, указывающий рейтинги товаров, которые нужно вывести (перечислять через запятую; 1 - новинки, 2 - хиты, 3 - распродажа)
* **warehouse** - параметр, указывающий на каких складах должны иметься товары (перечислять через запятую)
* **price\_from** - параметр, указывающий минимальную стоимость товаров, которые нужно выводить
* **price\_to** - параметр, указывающий максимальную стоимость товаров, которые нужно выводить
* **moscow** - параметр, указывающий, что будут выводиться товары, которые присутствуют на московском складе
* **remote** - параметр, указывающий, что будут выводиться товары, находяющиеся на удаленном складе
* **europe** - параметр, указывающий, что будут выводиться товары, находящиеся в европе
* **is\_vip** - параметр, указывающий, что будут выводиться товары, принадлежащие к VIP рубрикатору
* **exclude\_vip** - параметр, запрещающий выводить товары из VIP рубрикатора
* **min\_sum** - параметр, указывающий какой должна быть минимальная сумма товаров в наличиии по артикулу
* **not\_on\_order** - параметр, выключающий из выборки товары под заказ (rating=5)
* **exclude\_category** - параметр, указывающий какие категории нужно исключить из выборки (включая все вложенные категории и их товары; перечисление через запятую)
* **date\_from** - параметр, указывающий товары обновленные после какого числа нужно выводить в выборке (указывать в формате ДД-ММ-ГГГГ)
* **date\_to** - параметр, указывающий товары обновленные до какого числа нужно выводить в выборке (указывать в формате ДД-ММ-ГГГГ)
* **showDeleted** - параметр, включающий отображение удаленных (устаревших) товаров, использовать только для статистики. Автоматически добавляет вывод поля is\_deleted, в котором указывается удален товар или нет

## Доступные поля для параметра fields

* id - ID товара
* article - артикул
* parent\_color\_id - ID группировки по цвету
* parent\_size\_id - ID группировки по размеру
* name - наименование
* full\_name - полное наименование
* size - размер
* price - цена
* discount\_group\_id - ID группы скидок
* images - массив изображений
  * big - изображение в разрешении 400x300
  * small - изображение в разрешении 280x210
  * superbig - изображение в разрешении 1000x750
  * thumbnail - изображение в разрешении 80x60
  * updated\_at - время последнего обновления изображения, в секундах UNIX
* colors - массив цветов
  * name - название цвета
  * sort - порядок цвета
  * pantone - соответствующий цвет согласно системе Pantone
* categories - массив категорий, в которые входит товар
* brand\_id - ID бренда
* rating - идентификатор рейтинга (0 - обычный товар, 1 - новинка, 2 - хит, 3 - распродажа)
* description - описание товара
* attributes - различные характеристики товара
  * dim - единица измерения
  * name - название характеристики
  * value - значение
* materials - массив материалов
* brand - название бренда
* branding - названия нанесения, доступных для товара
* cdr - перечисление ссылок на макеты нанесения
* group\_id - ID группы товара
* full\_categories - массив категорий, в которые входит товар, без учета вложенности
* video\_id - ссылка на видео с товаром - устаревшее поле, см. **videos**
* package - массив упаковок товара
  * id - ID упаковки
  * type - вид упаковки
  * description - описание упаковки
  * size - размер упаковки
  * weight - вес с упаковкой
  * amount - количество в упаковке
  * volume - объем упаковки
  * is\_main - является ли эта упаковка главной
* color\_group\_id - ID группы товара по цвету
* parent\_volume\_id - ID группировки по объему
* parent\_gender\_id - ID группировки по полу
* is\_on\_order - товар доступен для заказа
* is\_high - товар принадлежит высоким брендам (запрещается выводить цену без спец. разрешения)
* size\_sort - порядок вывода по размеру
* parent\_id - ID родительского товара (до нанесения)
* branding\_option - массив дочерних товаров (с нанесением)
* article\_base - базовый артикул
* is\_vip - товар относится к VIP рубрикатору
* is\_stopped - товар больше не поставляется
* main\_category - ID главной категории товара
* discount\_price - цена со скидкой дилера
* total\_stock - общее количество на всех складах
* outlets - наличие товара на различных складах
* videos - список ссылок на видео, описывающие товар
* updated\_at - время последнего обновления товара
* is\_deleted - статус удаления товара