Поиск модели товара

Описание

GET /models

Возвращает информацию о моделях, удовлетворяющих заданным в запросе условиям поиска.

Примечание. Метод доступен начиная с версии 1.2 партнерского API Яндекс.Маркета.

URL ресурса:

https://api.partner.market.yandex.ru/v2/models.[format]

Входные данные

Параметр

Тип

Значение

Обязательные

query String

Поисковый запрос.

regionId

Int64

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET /regions.

Необязательные

currency

Enum

Валюта, в которой отображаются цены предложений на страницах с результатами поиска.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

page

Int32

Номер страницы результатов, которую необходимо показать в ответе.

Если указан номер страницы, превышающий общее количество найденных страниц, выдаются результаты по последней странице.

Значение по умолчанию: 1.

Максимальное значение: 50.

pageSize

Int32

Количество результатов на странице.

Значение по умолчанию и максимально возможное значение: 50.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <models currency="{enum}" region-id="{int64}">
    <model id="{int64}" name="{string}">
      <prices avg="{float}" max="{float}" min="{float}"/>
    </model>
    ...
  </models>
  <pager current-page="{int32}" from="{int32}" page-size="{int32}" pages-count="{int32}" to="{int32}" total="{int32}"/>
</response>

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

models models

Список моделей товаров, удовлетворяющих условиям поиска.

pager pager

Сводка по результатам поиска.

currency Enum

Валюта, в которой указаны цены предложений для модели.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Параметр выводится только для формата JSON.

regionId Int64

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET /regions/{regionId}.

Параметр выводится только для формата JSON.

Параметры, вложенные в models

currency Enum

Валюта, в которой указаны цены предложений для модели.

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Выводится только для формата XML и является атрибутом параметра models.

region-id Int64

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET /regions/{regionId}.

Выводится только для формата XML и является атрибутом параметра models.

model

Описание модели.

Параметр выводится только для формата XML.

Параметры, вложенные в model / models

id id Int64

Идентификатор модели товара.

Для формата XML является атрибутом параметра model.

name name String

Название модели товара.

Для формата XML является атрибутом параметра model.

prices prices

Информация о ценах на модель товара.

Параметры, вложенные в prices

avg avg Float

Средняя цена предложения для модели в регионе.

Для формата XML является атрибутом параметра prices.

max max Float

Максимальная цена предложения для модели в регионе.

Для формата XML является атрибутом параметра prices.

min min Float

Минимальная цена предложения для модели в регионе.

Для формата XML является атрибутом параметра prices.

Параметры, вложенные в pager

current-page currentPage Int32

Номер выводимой страницы результатов.

Если моделей, удовлетворяющих заданным в запросе условиям поиска, не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

from from Int32

Порядковый номер модели, с которой начинается выводимая страница результатов поиска.

Если моделей, удовлетворяющих заданным в запросе условиям поиска, не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

page-size pageSize Int32

Количество выводимых на странице моделей.

Если моделей, удовлетворяющих заданным в запросе условиям поиска, не найдено, значение параметра: 0.

До версии 2.0 партнерского API Яндекс.Маркета параметр в формате XML назывался on-page, в формате JSON — onPage.

Для формата XML является атрибутом параметра pager.

pages-count pagesCount Int32

Количество страниц с результатами.

Если моделей, удовлетворяющих заданным в запросе условиям поиска, не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

to to Int32

Порядковый номер модели, которой заканчивается выводимая страница результатов поиска.

Если моделей, удовлетворяющих заданным в запросе условиям поиска, не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

total total Int32

Общее количество найденных моделей.

Если моделей, удовлетворяющих заданным в запросе условиям поиска, не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

Описание ошибок

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 400 Bad Request

Invalid regionId: 'regionId'

Регион с идентификатором regionId не найден.

Проверьте корректность идентификатора региона.

Page number is too big: 'page'. Max page number is 'maxPage'

Номер страницы с результатами превышает максимальное количество страниц.

Увеличьте количество результатов, выводимых на странице, или уточните запрос для уменьшения количества результатов.

Too many models requested: 'count'. Maximum is 'maxCount'

Превышено функциональное ограничение на количество запрашиваемых моделей для ресурса за один запрос.

Уменьшите количество запрашиваемых моделей до разрешенного ограничениями.

Unsupported currency: 'currency'

Валюта currency не поддерживается.

Проверьте корректность кода валюты.

Ограничения

Для методов GET /models, GET /models/{modelId} и POST models действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

Объем запросов к ресурсу, который возможно выполнить в течение суток, рассчитывается индивидуально и зависит от следующих показателей:

  • количество предложений на карточках моделей;

  • количество активных магазинов клиента.

Примечание.

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml' GET 'https://api.partner.market.yandex.ru/v2/models.xml?query=iPhone+4s&regionId=2'

Пример ответа:

HTTP/1.1 200 OK
Date: Sun, 9 Jul 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <models currency="RUR" region-id="2">
    <model id="7717706" name="Apple iPhone 4S 16 Gb">
      <prices avg="24990" max="68400" min="21500"/>
    </model>
    <model id="7717686" name="Apple iPhone 4S 32 Gb">
      <prices avg="28500" max="46000" min="24450"/>
    </model>
    <model id="7717687" name="Apple iPhone 4S 64 Gb">
      <prices avg="32500" max="89950" min="27200"/>
    </model>
  </models>
  <pager current-page="1" from="1" page-size="3" pages-count="1088" to="3" total="3263"/>
</response>