Текстовый поиск

  1. Описание
  2. Входные данные
  3. Выходные данные
  4. Ошибки
  5. Ограничения
  6. Примеры

Описание

GET /search

Возвращает список товаров, найденных по текстовому запросу на Маркете.

Каждому товару соответствует своя страница — карточка товара. На одной карточке может размещаться несколько вариантов товара. Например, у смартфона могут быть разные цвета, а у чая — разное количество пакетиков. В результатах запроса, в зависимости от значения входного параметра fields, может возвращаться информация о карточке товара и варианте товара, который отображается на ней первым.

Запрос является регионозависимым, его результаты возвращаются постранично.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/search

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

Параметр

Тип

Значение

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

Поисковый запрос. Вы можете указать в нем:

  • название товара;
  • штрихкод товара в формате EAN‑13, EAN‑8, UPC‑A, UPC‑E или Code 128;
  • ISBN, если вы хотите найти конкретное книжное издание;
  • произвольный поисковый запрос, например, «мобильные телефоны» или «флешки 16 ГБ».

В поисковом запросе можно использовать кириллические и латинские буквы, числа, а также специальные символы, которые обозначаются с помощью кодов. Например, пробел кодируется как %20, запятая — %2C, знак процента — %25 и т. д. Подробнее о кодах см. в разделе Кодирование URL русскоязычной Википедии.

Примеры поисковых запросов
  • Пример произвольного запроса: text=баскетбольные%20мячи%20Molten.
  • Пример запроса со штрихкодом: text=4670028540084. В этом случае в ответе на запрос вернутся данные по Яндекс.Станции Мини.
geo_id Int32

Идентификатор региона, в котором нужно найти товары.

Список идентификаторов часто используемых регионов см. в разделе Регионозависимые запросы.

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

Формат выходных данных:

  • json
  • xml

Значение по умолчанию: json.
fields String

Информация о товаре, которую нужно получить (можно перечислить несколько значений через запятую):

  • MODEL_CATEGORY — категория товара.
  • MODEL_DEFAULT_OFFER — вариант товара, который отображается на его карточке первым.
  • MODEL_MEDIA — суммарное количество оценок и отзывов о товаре (параметр opinionCount) и количество обзоров товара (параметр reviewCount).
  • MODEL_OFFERS — количество вариантов товара (параметр offerCount).
  • MODEL_PHOTO — основное изображение товара (параметр photo).
  • MODEL_PHOTOS — все изображения товара (параметр photos).
  • MODEL_PRICE — обобщенная информация о ценах на варианты товара (параметр price): максимальной, минимальной и средней.
  • MODEL_RATING — информация об оценках товара (параметр rating).
  • OFFER_DELIVERY — условия доставки (параметр delivery) вариантов товара, возвращаемых в ответе. Для работы этого значения также нужно указать значение MODEL_DEFAULT_OFFER.
  • OFFER_PHOTO — все изображения (параметры photo и photos) вариантов товара, возвращаемых в ответе. Для работы этого значения также нужно указать значение MODEL_DEFAULT_OFFER.
  • MODEL_SPECIFICATION — основные характеристики товара (параметр specifications).
exact-match Boolean

Точный поиск.

Если в параметре text вы указываете название товара или произвольный текстовый запрос, с помощью параметра exact-match вы получите список товаров, в названии которых есть все слова из поискового запроса. Последовательность слов в названии и запросе может быть разной.

Чтобы использовать точный поиск, укажите значение true.
clid String

Идентификатор площадки.

Указанный идентификатор CLID добавляется в URL, возвращаемые в ответе, в виде query-параметра: {url}&clid=1234567&.... По умолчанию используется идентификатор площадки, для которой выдавался авторизационный ключ.

Идентификатор можно узнать у персонального менеджера. Если вы являетесь партнером Яндекс.Маркета, идентификатор также можно найти в интерфейсе Яндекс.Дистрибуции, на странице Продукты.
vid String

Дополнительный идентификатор для ссылок — строка длиной до 150 символов только из латинских букв, цифр и специальных знаков: ., :, -, _.

Указанный идентификатор добавляется в URL, возвращаемые в ответе, в виде query-параметра: {url}&vid=review&.... С его помощью можно отслеживать статистику по отдельной ссылке или сравнивать статистику по одинаковым ссылкам на разных страницах.

Подробнее см. в разделе Дополнительный идентификатор инструмента VID Справки партнерской сети Яндекс.Маркета.
page Int8

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

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

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

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

Параметр

Тип

Значение

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

Поисковый запрос. Вы можете указать в нем:

  • название товара;
  • штрихкод товара в формате EAN‑13, EAN‑8, UPC‑A, UPC‑E или Code 128;
  • ISBN, если вы хотите найти конкретное книжное издание;
  • произвольный поисковый запрос, например, «мобильные телефоны» или «флешки 16 ГБ».

В поисковом запросе можно использовать кириллические и латинские буквы, числа, а также специальные символы, которые обозначаются с помощью кодов. Например, пробел кодируется как %20, запятая — %2C, знак процента — %25 и т. д. Подробнее о кодах см. в разделе Кодирование URL русскоязычной Википедии.

Примеры поисковых запросов
  • Пример произвольного запроса: text=баскетбольные%20мячи%20Molten.
  • Пример запроса со штрихкодом: text=4670028540084. В этом случае в ответе на запрос вернутся данные по Яндекс.Станции Мини.
geo_id Int32

Идентификатор региона, в котором нужно найти товары.

Список идентификаторов часто используемых регионов см. в разделе Регионозависимые запросы.

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

Формат выходных данных:

  • json
  • xml

Значение по умолчанию: json.
fields String

Информация о товаре, которую нужно получить (можно перечислить несколько значений через запятую):

  • MODEL_CATEGORY — категория товара.
  • MODEL_DEFAULT_OFFER — вариант товара, который отображается на его карточке первым.
  • MODEL_MEDIA — суммарное количество оценок и отзывов о товаре (параметр opinionCount) и количество обзоров товара (параметр reviewCount).
  • MODEL_OFFERS — количество вариантов товара (параметр offerCount).
  • MODEL_PHOTO — основное изображение товара (параметр photo).
  • MODEL_PHOTOS — все изображения товара (параметр photos).
  • MODEL_PRICE — обобщенная информация о ценах на варианты товара (параметр price): максимальной, минимальной и средней.
  • MODEL_RATING — информация об оценках товара (параметр rating).
  • OFFER_DELIVERY — условия доставки (параметр delivery) вариантов товара, возвращаемых в ответе. Для работы этого значения также нужно указать значение MODEL_DEFAULT_OFFER.
  • OFFER_PHOTO — все изображения (параметры photo и photos) вариантов товара, возвращаемых в ответе. Для работы этого значения также нужно указать значение MODEL_DEFAULT_OFFER.
  • MODEL_SPECIFICATION — основные характеристики товара (параметр specifications).
exact-match Boolean

Точный поиск.

Если в параметре text вы указываете название товара или произвольный текстовый запрос, с помощью параметра exact-match вы получите список товаров, в названии которых есть все слова из поискового запроса. Последовательность слов в названии и запросе может быть разной.

Чтобы использовать точный поиск, укажите значение true.
clid String

Идентификатор площадки.

Указанный идентификатор CLID добавляется в URL, возвращаемые в ответе, в виде query-параметра: {url}&clid=1234567&.... По умолчанию используется идентификатор площадки, для которой выдавался авторизационный ключ.

Идентификатор можно узнать у персонального менеджера. Если вы являетесь партнером Яндекс.Маркета, идентификатор также можно найти в интерфейсе Яндекс.Дистрибуции, на странице Продукты.
vid String

Дополнительный идентификатор для ссылок — строка длиной до 150 символов только из латинских букв, цифр и специальных знаков: ., :, -, _.

Указанный идентификатор добавляется в URL, возвращаемые в ответе, в виде query-параметра: {url}&vid=review&.... С его помощью можно отслеживать статистику по отдельной ссылке или сравнивать статистику по одинаковым ссылкам на разных страницах.

Подробнее см. в разделе Дополнительный идентификатор инструмента VID Справки партнерской сети Яндекс.Маркета.
page Int8

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

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

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

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

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

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

{
  "status": "{enum}",
  "context": 
  {
    "id": "{string}",
    "time": "{date}",
    "link": "{string}",
    "marketUrl": "{string}",
    "region": 
    {
      "id": {int32},
      "name": "{string}",
      "type": "{enum}",
      "childCount": {int32},
      "country": 
      {
        "id": {int32},
        "name": "{string}",
        "type": "{enum}",
        "childCount": {int32}
      }
    },
    "currency": 
    {
      "id": "{string}",
      "name": "{string}"
    },
    "page":
    {
      "number": {int32},
      "count": {int32},
      "total": {int32},
      "last": {boolean},
      "totalItems": {int32}
    }
  },
  "items": 
  [
    {
      "id": {int64},
      "name": "{string}",
      "link": "{string}",
      "offerCount": {int64},
      "opinionCount": {int32},
      "reviewCount": {int32},
      "description": "{string}",
      "specifications": [
      {
      "name": "{string}",
      "features": [
      {
      "name": "{string}",
      "value": "{string}",
      },
      ...
      ],
      },
      ],
      "photo": 
      {
        "width": {int32},
        "height": {int32},
        "url": "{string}"
      },
      "photos":
      [
        {
          "width": {int32},
          "height": {int32},
          "url": "{string}"
        },
        ...
      ],
      "category":
      {
        "id": {int32},
        "name": "{string}",
      },
      "price": 
      {
        "max": "{string}",
        "min": "{string}",
        "avg": "{string}"
      },
      "rating": 
      {
        "value": {float},
        "count": {int32}
      },
      "offer":
      {
        "sku": "{string}",
        "name": "{string}",
        "url": "{string}",
        "description": "{string}",
        "price":
        {
          "value": "{string}",
          "discount": "{string}",
          "base": "{string}"
        },
        "photo": 
        {
          "width": {int32},
          "height": {int32},
          "url": "{string}"
        },
        "photos":
        [
          {
            "width": {int32},
            "height": {int32},
            "url": "{string}"
          },
          ...
        ],
        "delivery":
        {
          "brief": "{string}",
          "price":
          {
            "value": "{string}",
            "base": "{string}"
          }
        }
      }
    },
    ...
  ]
}

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

Параметр для формата JSON Параметр для формата XML Тип Описание
result

Ответ.

Параметр возвращается только для формата XML.
Параметры, вложенные в result
status status

Enum

Статус выполнения запроса:

  • OK — запрос выполнен успешно.

  • ERROR — произошла ошибка.

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

Информация о запросе.
items items

Список товаров, найденных по поисковому запросу.
Параметры, вложенные в context
id id

String

Идентификатор запроса.

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

Date

Дата и время выполнения запроса.

Формат даты: ISO 8601 с миллисекундами и смещением относительно UTC. Например, 2017-11-21T00:00:00.000+03:00.

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

String

URL страницы запроса на Маркете.

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

String

URL Маркета.

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

Регион, для которого возвращаются данные.
currency currency

Валюта, в которой указаны цены в ответе.
page page

Информация о страницах результатов.
Параметры, вложенные в region
id id

Int32

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

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

String

Название региона.

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

Enum

Тип региона:

  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого‑либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

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

Int32

Количество дочерних регионов.

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

Страна, в которой расположен регион.
Параметры, вложенные в country
id id

Int32

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

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

String

Название страны.

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

Enum

Тип региона:

  • COUNTRY — страна.

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

Int32

Количество дочерних регионов.

Для формата XML является атрибутом параметра country.
Параметры, вложенные в currency
id id

Enum

Код валюты:

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

String

Название валюты.
Параметры, вложенные в page
number number

Int32

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

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

Int32

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

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

Int32

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

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

Boolean

Является ли текущая страница результатов последней:

  • true — да;
  • false — нет.

Если параметр не возвращается, страница не является последней.

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

Int32

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

Для формата XML является атрибутом параметра page.
Параметры, вложенные в items
item

Информация о товаре.

Параметр возвращается только для формата XML.
Параметры, вложенные в items / item
id id

Int64

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

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

String

Название товара.

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

String

URL карточки товара на Маркете.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

Int64

Количество вариантов товара.

Возвращается, только если во входном параметре fields указано значение MODEL_OFFERS.

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

Int32

Суммарное количество оценок и отзывов о товаре.

Возвращается, только если во входном параметре fields указано значение MODEL_MEDIA.

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

Int32

Количество обзоров товара.

Возвращается, только если во входном параметре fields указано значение MODEL_MEDIA.

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

String

Описание товара.
specifications specifications

Основные характеристики товара.

Возвращается, только если во входном параметре fields указано значение MODEL_SPECIFICATION.
photo photo

Основное изображение товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.
photos photos

Все изображения товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.
category category

Информация о категории, к которой относится товар.

Возвращается, только если во входном параметре fields указано значение MODEL_CATEGORY.
price price

Обобщенная информация о ценах на варианты товара: максимальной, минимальной и средней.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.
rating rating

Информация о рейтинге товара.

Возвращается, только если во входном параметре fields указано значение MODEL_RATING.
offer offer

Информация о варианте товара, который отображается на его карточке первым.

На одной карточке может размещаться несколько вариантов товара. Например, у смартфона могут быть разные цвета, а у чая — разное количество пакетиков.

Информацию обо всех вариантах товара можно получить с помощью запроса GET /models/{modelId}/offers.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.
Параметры, вложенные в specifications (items)
name name

String

Название характеристики товара

Возвращается, только если во входном параметре fields указано значение MODEL_SPECIFICATION.
feature feature

String

Значение характеристики товара

Возвращается, только если во входном параметре fields указано значение MODEL_SPECIFICATION.
Параметры, вложенные в photo (items)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в photos (items)
photo

Изображение товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.
Параметры, вложенные в photos / photo (items)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в category
id id

Int32

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

Возвращается, только если во входном параметре fields указано значение MODEL_CATEGORY.

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

String

Название категории.

Возвращается, только если во входном параметре fields указано значение MODEL_CATEGORY.

Для формата XML является атрибутом параметра category.
Параметры, вложенные в price (items)
max max

String

Цена самого дорогого варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Цена самого дешевого варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Средняя цена вариантов товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

Для формата XML является атрибутом параметра price.
Параметры, вложенные в rating
value value

Double

Рейтинг товара от 1 до 5.

Возвращается, только если во входном параметре fields указано значение MODEL_RATING.

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

Int32

Количество оценок товара.

Возвращается, только если во входном параметре fields указано значение MODEL_RATING.

Для формата XML является атрибутом параметра rating.
Параметры, вложенные в offer
sku sku String

Идентификатор варианта товара (SKU на Маркете).

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

String

Название варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

String

URL варианта товара на Маркете.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

String

Описание варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.
price price

Информация о цене варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.
photo photo

Основное изображение варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.
photos photos

Все изображения варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.
delivery delivery

Информация о доставке варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.
Параметры, вложенные в price (offer)
value value

String

Цена варианта товара. Если на вариант товара действует скидка, указана цена со скидкой.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Скидка на вариант товара в процентах.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER и на вариант товара действует скидка.

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

String

Цена варианта товара без скидки.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER и на вариант товара действует скидка.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

Для формата XML является атрибутом параметра price.
Параметры, вложенные в photo (offer)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в photos (offer)
photo

Изображение варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.
Параметры, вложенные в photos / photo (offer)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в delivery
brief brief

String

Краткое описание условий доставки.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.

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

Int32

Информация о стоимости доставки.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.

Для формата XML является атрибутом параметра delivery.
Параметры, вложенные в price (delivery)
value value

String

Стоимость доставки. Если на доставку действует скидка, указана цена со скидкой.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Стоимость доставки без скидки.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY и на доставку действует скидка.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

Для формата XML является атрибутом параметра price.
Параметр для формата JSON Параметр для формата XML Тип Описание
result

Ответ.

Параметр возвращается только для формата XML.
Параметры, вложенные в result
status status

Enum

Статус выполнения запроса:

  • OK — запрос выполнен успешно.

  • ERROR — произошла ошибка.

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

Информация о запросе.
items items

Список товаров, найденных по поисковому запросу.
Параметры, вложенные в context
id id

String

Идентификатор запроса.

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

Date

Дата и время выполнения запроса.

Формат даты: ISO 8601 с миллисекундами и смещением относительно UTC. Например, 2017-11-21T00:00:00.000+03:00.

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

String

URL страницы запроса на Маркете.

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

String

URL Маркета.

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

Регион, для которого возвращаются данные.
currency currency

Валюта, в которой указаны цены в ответе.
page page

Информация о страницах результатов.
Параметры, вложенные в region
id id

Int32

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

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

String

Название региона.

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

Enum

Тип региона:

  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого‑либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

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

Int32

Количество дочерних регионов.

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

Страна, в которой расположен регион.
Параметры, вложенные в country
id id

Int32

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

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

String

Название страны.

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

Enum

Тип региона:

  • COUNTRY — страна.

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

Int32

Количество дочерних регионов.

Для формата XML является атрибутом параметра country.
Параметры, вложенные в currency
id id

Enum

Код валюты:

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

String

Название валюты.
Параметры, вложенные в page
number number

Int32

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

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

Int32

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

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

Int32

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

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

Boolean

Является ли текущая страница результатов последней:

  • true — да;
  • false — нет.

Если параметр не возвращается, страница не является последней.

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

Int32

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

Для формата XML является атрибутом параметра page.
Параметры, вложенные в items
item

Информация о товаре.

Параметр возвращается только для формата XML.
Параметры, вложенные в items / item
id id

Int64

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

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

String

Название товара.

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

String

URL карточки товара на Маркете.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

Int64

Количество вариантов товара.

Возвращается, только если во входном параметре fields указано значение MODEL_OFFERS.

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

Int32

Суммарное количество оценок и отзывов о товаре.

Возвращается, только если во входном параметре fields указано значение MODEL_MEDIA.

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

Int32

Количество обзоров товара.

Возвращается, только если во входном параметре fields указано значение MODEL_MEDIA.

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

String

Описание товара.
specifications specifications

Основные характеристики товара.

Возвращается, только если во входном параметре fields указано значение MODEL_SPECIFICATION.
photo photo

Основное изображение товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.
photos photos

Все изображения товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.
category category

Информация о категории, к которой относится товар.

Возвращается, только если во входном параметре fields указано значение MODEL_CATEGORY.
price price

Обобщенная информация о ценах на варианты товара: максимальной, минимальной и средней.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.
rating rating

Информация о рейтинге товара.

Возвращается, только если во входном параметре fields указано значение MODEL_RATING.
offer offer

Информация о варианте товара, который отображается на его карточке первым.

На одной карточке может размещаться несколько вариантов товара. Например, у смартфона могут быть разные цвета, а у чая — разное количество пакетиков.

Информацию обо всех вариантах товара можно получить с помощью запроса GET /models/{modelId}/offers.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.
Параметры, вложенные в specifications (items)
name name

String

Название характеристики товара

Возвращается, только если во входном параметре fields указано значение MODEL_SPECIFICATION.
feature feature

String

Значение характеристики товара

Возвращается, только если во входном параметре fields указано значение MODEL_SPECIFICATION.
Параметры, вложенные в photo (items)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указано значение MODEL_PHOTO.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в photos (items)
photo

Изображение товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.
Параметры, вложенные в photos / photo (items)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указаны значения MODEL_PHOTOS.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в category
id id

Int32

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

Возвращается, только если во входном параметре fields указано значение MODEL_CATEGORY.

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

String

Название категории.

Возвращается, только если во входном параметре fields указано значение MODEL_CATEGORY.

Для формата XML является атрибутом параметра category.
Параметры, вложенные в price (items)
max max

String

Цена самого дорогого варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Цена самого дешевого варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Средняя цена вариантов товара.

Возвращается, только если во входном параметре fields указано значение MODEL_PRICE.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

Для формата XML является атрибутом параметра price.
Параметры, вложенные в rating
value value

Double

Рейтинг товара от 1 до 5.

Возвращается, только если во входном параметре fields указано значение MODEL_RATING.

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

Int32

Количество оценок товара.

Возвращается, только если во входном параметре fields указано значение MODEL_RATING.

Для формата XML является атрибутом параметра rating.
Параметры, вложенные в offer
sku sku String

Идентификатор варианта товара (SKU на Маркете).

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

String

Название варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

String

URL варианта товара на Маркете.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

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

String

Описание варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.
price price

Информация о цене варианта товара.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.
photo photo

Основное изображение варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.
photos photos

Все изображения варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.
delivery delivery

Информация о доставке варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.
Параметры, вложенные в price (offer)
value value

String

Цена варианта товара. Если на вариант товара действует скидка, указана цена со скидкой.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Скидка на вариант товара в процентах.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER и на вариант товара действует скидка.

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

String

Цена варианта товара без скидки.

Возвращается, только если во входном параметре fields указано значение MODEL_DEFAULT_OFFER и на вариант товара действует скидка.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

Для формата XML является атрибутом параметра price.
Параметры, вложенные в photo (offer)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в photos (offer)
photo

Изображение варианта товара.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.
Параметры, вложенные в photos / photo (offer)
width width

Int32

Ширина изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

Int32

Высота изображения в пикселях.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

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

String

URL изображения.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_PHOTO.

Для формата XML является атрибутом параметра photo.
Параметры, вложенные в delivery
brief brief

String

Краткое описание условий доставки.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.

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

Int32

Информация о стоимости доставки.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.

Для формата XML является атрибутом параметра delivery.
Параметры, вложенные в price (delivery)
value value

String

Стоимость доставки. Если на доставку действует скидка, указана цена со скидкой.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

String

Стоимость доставки без скидки.

Возвращается, только если во входном параметре fields указаны значения MODEL_DEFAULT_OFFER и OFFER_DELIVERY и на доставку действует скидка.

Информация о валюте, в которой указана цена, возвращается в параметре currency.

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

Ошибки

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

Ограничения

В течение секунды можно отправить не более 2 запросов.

Примеры

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/search'\
'?text=iphone%20x'\
'&geo_id=213'\
'&count=1'\
'&fields=MODEL_PRICE,MODEL_DEFAULT_OFFER,MODEL_SPECIFICATION'\
'&format=json'

Ответ:

HTTP/1.1 200 OK
Date: Thu, 19 Sep 2019 11:28:04 GMT
Content-Type: application/json;charset=utf-8
...

{
  "status": "OK",
  "context": 
  {
    "id": "1568892609697/59759a67d09709e2ef14b146e6920500",
    "time": "2019-09-19T14:27:59.977+03:00",
    "link": "https://market.yandex.ru/search?onstock=0&text=iphone+x&free-delivery=0
            &pp=1930&mclid=1003&distr_type=7&clid=2310490",
    "marketUrl": "https://market.yandex.ru?pp=1930&mclid=1003&distr_type=7&clid=2310490",
    "region": 
    {
      "id": 213,
      "name": "Москва",
      "type": "CITY",
      "childCount": 14,
      "country": 
      {
        "id": 225,
        "name": "Россия",
        "type": "COUNTRY",
        "childCount": 10
      }
    },
    "currency": 
    {
      "id": "RUR",
      "name": "руб."
    },
    "page":
    {
      "number": 1,
      "count": 1,
      "total": 242,
      "totalItems": 242
    }
  },
  "items": 
  [
    {
      "id": 1759344314,
      "name": "Смартфон Apple iPhone X 64GB",
      "link": 
      "https://market.yandex.ru/product/smartfon-apple-iphone-x-64gb-seryi-kosmos-mqac2ru-a
        /100210864686?show-uid=15688930084968704733806001&pp=1930&mclid=1003
        &distr_type=7&clid=2310490",
      "description": 
        "Стильный и надёжный смартфон Apple iPhone X оснащён 
        ультра-производительным процессором А11 Bionic и стабильным программным 
        обеспечением. Полноэкранный дисплей Super Retina с диагональю 5.8 дюйма 
        демонстрирует невероятно яркую, контрастную и живую картинку. Корпус аппарата 
        защищён от воды и пыли.",
        "specifications": [
        {
        "name": "friendly",
        "features": [
        {
        "name": "экран",
        "value": "6.1\" (2532x1170) OLED 120 Гц"
        },
        {
        "name": "встроенная память",
        "value": "256 ГБ, 128 ГБ, 512 ГБ, 1 ТБ"
        },
        {
        "name": "оперативная память",
        "value": "6 ГБ"
        },
        {
        "name": "3 камеры",
        "value": "12 МП, 12 МП, 12 МП"
        },
        {
        "name": "процессор",
        "value": "Apple A15 Bionic"
        },
        {
        "name": "SIM-карты",
        "value": "2 (nano SIM+eSIM)"
        },
        {
        "name": "операционная система",
        "value": "iOS 15"
        },
        {
        "name": "беспроводные интерфейсы",
        "value": "NFC, Bluetooth, Wi-Fi"
        },
        {
        "name": "стандарт связи",
        "value": "4G LTE, 5G, 3G"
        },
        {
        "name": "степень защиты",
        "value": "IP68"
        },
        {
        "name": "вес",
        "value": "203 г"
        }
        ]
        }
        ]
      "price": 
      {
        "max": "63990",
        "min": "63990",
        "avg": "63990"
      },
      "offer":
      {
        "sku": "100210864686",
        "name": "Смартфон Apple iPhone X 64GB серый космос (MQAC2RU/A)",
        "url": 
        "https://market.yandex.ru/product/smartfon-apple-iphone-x-64gb-seryi-kosmos-mqac2ru-a
          /100210864686?show-uid=15688930084968704733806001&pp=1930&mclid=1003
          &distr_type=7&clid=2310490",
        "price":
        {
          "value": "63990",
          "discount": "9.86054",
          "base": "70990"
        }
      }
    }
  ]
}