Руководство разработчика
Ресурсы API

Общие входные параметры

Общие входные параметры можно передавать при вызове любого из методов. При этом они не всегда напрямую влияют на выходные данные.

Общие входные параметры необходимо передавать в URL запроса:

<тип_метода> https://api.content.market.yandex.ru/v<версия_API>/<ресурс>?<параметры>
Примечание. Так как общие входные параметры можно указывать во всех запросах, для упрощения в описаниях методов API указаны только параметры, оказывающие влияние на выходные данные.
ПараметрПоложе­ниеТипОбяза­тельностьОписание
version PATH Enum Да

Версия контентного API.

Authorization HEADER String Да

Ключ идентификации клиента Контентного API Яндекс.Маркета

format QUERY Enum Нет

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

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

  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.

Значение по умолчанию: JSON.
Региональные настройки
currency QUERY Enum Нет

Валюта запроса.

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

  • BYR — белорусский рубль;
  • EUR — евро.
  • KZT — казахстанский тенге;
  • RUR — российский рубль;
  • UAH — украинская гривна;
  • USD — доллар США;

Значение по умолчанию: Валюта запроса определяется по региону пользователя. Если определить невозможно, принимается равной RUR. .
Параметры для определения региона пользователя для формирования выдачи с учетом региона

Параметр remote_ip имеет более высокий приоритет, чем geo_id.

Если в качестве входных данных задать оба параметра, выдача будет сформирована на основании remote_ip.

geo_id QUERY Int64 Да, если не задан remote_ip

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

remote_ip QUERY String Да, если не задан geo_id

IP-адрес пользователя, по которому определяется его регион. На основании IP-адреса формируется выдача с учетом региона.

Общие параметры некоторых запросов
html_content QUERY Boolean Нет

Признак отображения описания моделей и товарных предложений в формате HTML.

Параметры, определяющие размеры для изменения размеров изображений
height QUERY Int32 Нет

Требуемая высота изображения.

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

Ограничения:

  • Минимальное значение 0

Значение по умолчанию: 0.
width QUERY Int32 Нет

Требуемая ширина изображения.

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

Ограничения:

  • Минимальное значение 0

Значение по умолчанию: 0.
Общие входные параметры