module TorgMailruApi::APIMethods
Public Instance Methods
Список категорий: получение списка товарных категорий верхнего уровня. @macro api_method @macro geodependent @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 196 def categories params listing "category", params end
Информация о категории: получение информации о товарной категории. @macro api_method @macro geodependent @macro category_id @macro returns_object
# File lib/torg_mailru_api.rb, line 217 def category category_id, params get "category/#{category_id}", params end
Список подкатегорий: получение списка подкатегорий для товарной категории. @macro api_method @macro geodependent @macro category_id @option params [Symbol] :type (:all) Фильтрация выходных данных по типу товарной категории (:all | :model | :parameterized | :general) @option params [Integer] :page (1) Номер страницы @option params [Integer] :results_per_page (выводятся все результаты) Количество результатов на страницу (max: 30) @macro returns_listing
# File lib/torg_mailru_api.rb, line 208 def category_children category_id, params listing "category/#{category_id}/children", params end
Параметрический поиск: получение списка моделей категории, удовлетворяющих набору заданных параметров. @macro api_method @macro geodependent @option params [String] <parameter_id> Параметр товарной категории. В запросе вместо <parameter_id> указыватся id параметра.
Список параметров и их id для определенной товарной категории можно получить с помощью ресурса "Список параметров категории". Значение зависит от типа выбранного параметра категории: * тип параметра numeric — числовое значение <value> или числовой диапазон, значения границ которого разделяются запятой "<min_value>,<max_value>"; * тип параметра enum — список идентификаторов допустимых значений параметра, разделенный запятыми, "<value1_id>,<value2_id>,<value3_id>", где <valueN_id> — идентификатор значения; * тип параметра bool — допустимые значения параметра: "true" и "false".
@option params [Symbol] :sort (:popular) Тип сортировки результатов поиска (:date — по новизне; :popular — по популярности; :price — по цене) @macro default_sort_order @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 369 def category_filter category_id, params listing "category/#{category_id}/filter", params end
Список хитов продаж категории: получение списка 50 моделей-хитов продаж модельной товарной категории. @note Список отсортирован по степени убывания популярности у покупателей. @note Для обычных категорий ресурс возвращает ошибку. @macro api_method @macro category_id @macro geodependent @macro returns_object
# File lib/torg_mailru_api.rb, line 263 def category_hits category_id, params get "category/#{category_id}/hits", params end
Список моделей категории: получение списка моделей в модельной товарной категории. @note Для обычных категорий ресурс возвращает ошибку. @macro api_method @macro geodependent @macro category_id @option params [Integer] :vendor_id Идентификатор производителя @option params [Symbol] :sort (:popular) Тип сортировки моделей (:date — сортировка по новизне; :popular — сортировка по популярности; :price — сортировка по цене) @macro default_sort_order @macro returns_listing
# File lib/torg_mailru_api.rb, line 239 def category_models category_id, params listing "category/#{category_id}/models", params end
Список новинок категории: получение списка моделей в модельной товарной категории. @note Для обычных категорий ресурс возвращает ошибку. @macro api_method @macro category_id @macro geodependent @option params [Symbol] :sort (:popular) Тип сортировки моделей (:popular — сортировка по популярности; :price — сортировка по цене) @macro default_sort_order @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 276 def category_newmodels category_id, params listing "category/#{category_id}/newmodels", params end
Список товарных предложений категории: получение списка товарных предложений в обычной товарной категории. @note Для модельных и параметризированных категорий ресурс возвращает ошибку. @macro api_method @macro category_id @macro geodependent @option params [Symbol] :sort (:auction) Тип сортировки предложений (:auction — по убыванию ставки; :price — сортировка по цене) @macro default_sort_order @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 252 def category_offers category_id, params listing "category/#{category_id}/offers", params end
Список параметров категории: получение списка параметров товарной категории. @macro api_method @macro category_id @option params [Symbol] :parameter_set (:popular) Тип набора параметров категории (:popular — популярные; :all — все) @macro returns_object
# File lib/torg_mailru_api.rb, line 226 def category_parameters category_id, params=nil get "category/#{category_id}/parameters", params end
Информация о модели: получение информации об указанной модели. @macro api_method @macro model_id @macro geodependent @macro returns_object
# File lib/torg_mailru_api.rb, line 287 def model model_id, params get "model/#{model_id}", params end
Список предложений модели: получение списка товарных предложений указанной модели. @macro api_method @macro model_id @macro geodependent @option params [Symbol] :sort (:auction) Тип сортировки предложений (:auction — по убыванию ставки; :price — по цене,
:rating — по рейтингу магазина + цене, :range — по расстоянию до ближайшей точки продаж (при указании местоположения пользователя)). * Если у параметра :sort указано значение :price, сортировка по возрастанию; * если у параметра :sort указано значение :rating, сортировка по убыванию; * если у параметра :sort указано значение :range, сортировка по возрастанию.
@option params [Symbol] :sort_order (:desc) Направление сортировки (:asc — по возрастанию; :desc — по убыванию).
Задается только в том случае, если у параметра :sort указано значение :price
@macro paginated @macro user_location @macro returns_listing
# File lib/torg_mailru_api.rb, line 314 def model_offers model_id, params listing "model/#{model_id}/offers", params end
Список точек продаж модели: получение списка точек продаж указанной модели. @macro api_method @macro model_id @macro geodependent @macro paginated @macro user_location @macro returns_listing
# File lib/torg_mailru_api.rb, line 325 def model_outlets model_id, params listing "model/#{model_id}/outlets", params end
Список характеристик модели: получение списка характеристик указанной модели. @macro api_method @macro model_id @option params :parameter_set [Symbol] (:popular) Тип набора параметров категории (:popular — популярные, :all — все) @macro returns_object
# File lib/torg_mailru_api.rb, line 296 def model_parameters model_id, params=nil get "model/#{model_id}/parameters", params end
Информация о товарном предложении: получение расширенной информации об указанном товарном предложении магазина. @macro api_method @macro offer_id @macro returns_object
# File lib/torg_mailru_api.rb, line 335 def offer offer_id, params=nil get "offer/#{offer_id}", params end
Информация о регионе: получение информации о выбранном регионе. @macro region_id @macro returns_object
# File lib/torg_mailru_api.rb, line 447 def region region_id get "region/#{region_id}" end
Список дочерних регионов: получение списка дочерних регионов для выбранного региона. @macro api_method @macro region_id @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 440 def region_children region_id, params=nil listing "region/#{region_id}/children", params end
Текстовый поиск региона: получение списка регионов, удовлетворяющих строке запроса. @option params [String] :query Полное или частичное название региона (обязательно!) @option params [Integer] :total (5) Количество результатов (max: 10) @macro returns_object
# File lib/torg_mailru_api.rb, line 455 def region_suggest params get "region/suggest", params end
Список регионов: получение списка регионов верхнего уровня. @macro api_method @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 431 def regions params=nil listing "regions", params end
Полнотекстовый поиск: получение списка моделей и товарных предложений, удовлетворяющих строке запроса. @macro api_method @macro geodependent @option params [String] :query Поисковый запрос (обязательно!) @option params [Integer] :category_id Фильтрация результатов поиска по товарной категории @option params [Integer] :seller_id Фильтрация результатов поиска по магазину @option params [Integer] :price_min Фильтрация результатов поиска по минимальной цене товарных предложений @option params [Integer] :price_max Фильтрация результатов поиска по максимальной цене товарных предложений @option params [Symbol] :sort (:relevance) Тип сортировки результатов поиска (:price — сортировка по возрастанию цены, :relevance — по релевантности) @macro paginated @macro returns_listing
# File lib/torg_mailru_api.rb, line 352 def search params listing "search", params end
Информация о магазине: получение информации о выбранном магазине. @macro seller_id @macro returns_object
# File lib/torg_mailru_api.rb, line 392 def seller seller_id get "seller/#{seller_id}" end
Список точек продаж магазина: получение списка точек продаж выбранного магазина. @macro api_method @macro seller_id @macro geodependent @macro paginated @macro user_location @macro returns_listing
# File lib/torg_mailru_api.rb, line 403 def seller_outlets seller_id, params listing "seller/#{seller_id}/outlets", params end
Отзывы о магазине: получение списка отзывов о магазине. @macro api_method @option params [Symbol] :sort (:date) Тип сортировки отзывов (:mark — по оценке пользователя; :date — по дате добавления отзыва; :valuable — по оценке полезности отзыва) @macro default_sort_order @option params [Integer,Symbol] :mark (:all) Фильтрация отзывов по оценке магазина (1, 2, 3, 4, 5; :all — все значения) @option params [Integer] :page (1) Номер страницы @option params [Integer] :results_per_page (выводятся все результаты) Количество результатов на страницу (max: 30) @macro returns_listing
# File lib/torg_mailru_api.rb, line 383 def seller_reviews seller_id, params listing "seller/#{seller_id}/reviews", params end
Информация о производителе: получение информации о производителе. @macro vendor_id @macro returns_object
# File lib/torg_mailru_api.rb, line 421 def vendor vendor_id get "vendor/#{vendor_id}" end
Список производителей: получение списка производителей, товары которых представлены в каталоге моделей на Товарах@Mail.Ru @option params [Integer] :category_id Идентификатор товарной категории, для которой нужно получить список производителей @option params [Integer] :page (1) Номер страницы @option params [Integer] :results_per_page (выводятся все результаты) Количество результатов на страницу (max: 30) @macro returns_listing
# File lib/torg_mailru_api.rb, line 414 def vendors params=nil listing "vendor" end