Информация о модели

Описание

GET /models/{modelId}

Возвращает информацию о модели товара.

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

URL ресурса:

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

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

Параметр

Тип

Значение

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

modelId

Int64

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

regionId

Int64

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

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

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

currency

Enum

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

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

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

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

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

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

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

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

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

<response>
  <models currency="{enum}" region-id="{int64}" >
    <model id="{int64}" name="{string}">
      <prices avg="{float}" max="{float}" min="{float}"/>
    </model>
  </models>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

models models

Модель товара.

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.

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

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

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

Описание

Пояснение

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

Ошибка 400 Bad Request

Invalid regionId: 'regionId'

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

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

Unsupported currency: 'currency'

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

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

Ошибка 404 Not Found

Model not found: 'modelId'

Модель с идентификатором modelId не найдена.

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

Ограничения

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

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

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

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

Примечание.

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

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

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

Примеры

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

curl -i -H 'Content-Type: application/xml' GET 'https://api.partner.market.yandex.ru/v2/models/7012977.xml?regionId=213'

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

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="213">
    <model id="7012977" name="Galaxy S II I9100">
      <prices avg="22690" max="50000" min="14130"/>
    </model>
  </models>
</response>