Настройки магазина

Описание

GET /campaigns/{campaignId}/settings

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

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

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/settings.[format]

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

Параметр Тип Значение
Обязательные

campaignId

Int64

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

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

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

<response>
  <settings country-region="{int64}" is-online="{boolean}" shop-name="{string}" show-in-context="{boolean}" show-in-premium="{boolean}" show-in-snippets="{boolean}" use-open-stat="{boolean}">
    <local-region id="{int64}" name="{string}" type="{enum}">
      <delivery>
        <schedule available-on-holidays="{boolean}" source="{enum}">
          <custom-holidays>
            <date>{date}</date>
            ...
          </custom-holidays>
          <custom-working-days>
            <date>{date}</date>
            ...
          </custom-working-days>
          <period from-date="{date}" to-date="{date}"/>
          <total-holidays>
            <date>{date}</date>
            ...
          </total-holidays>
          <weekly-holidays>
            <dow>{int8}</dow>
            ...
          </weekly-holidays>
        </schedule>
      </delivery>
    </local-region>
  </settings>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

settings settings

Настройки магазина.

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

country-region countryRegion Int64

Идентификатор региона, в котором находится магазин.

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

is-online isOnline Boolean

Тип магазина.

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

  • false — розничный магазин.

  • true — интернет-магазин.

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

shop-name shopName String

Наименование магазина на Яндекс.Маркете.

Если наименование отсутствует, значение параметра для формата XML выводится пустым, для формата JSON — null.

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

show-in-context showInContext Boolean

Признак размещения магазина на сайтах партнеров Яндекс.Дистрибуции.

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

  • false — магазин не размещен на сайтах партнеров Яндекс.Дистрибуции.

  • true — магазин размещен на сайтах партнеров Яндекс.Дистрибуции.

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

show-in-premium showInPremium Boolean

Признак показа предложений магазина в рекламном блоке над результатами поиска (Спецразмещение).

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

  • false — предложения не показываются в блоке Спецразмещения.

  • true — предложения показываются в блоке Спецразмещения.

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

show-in-snippets showInSnippets Boolean

Признак использования в поиске Яндекса данных из прайс-листа магазина.

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

  • false — данные не используются в поиске Яндекса.
  • true — данные используются в поиске Яндекса.

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

use-open-stat useOpenStat Boolean

Признак использования внешней интернет-статистики.

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

  • false — внешняя интернет-статистика не используется.
  • true — внешняя интернет-статистика используется.

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

local-region localRegion

Информация о своем регионе магазина.

Параметры, вложенные в local-region / localRegion

id id Int64

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

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

name name String

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

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

type type Enum

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

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

  • COUNTRY — страна.

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

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

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

  • REGION — регион.

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

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

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

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

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

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

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

delivery delivery

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

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

schedule schedule

Расписание работы службы доставки в своем регионе.

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

available-on-holidays availableOnHolidays Boolean

Признак работы службы доставки в государственные праздники.

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

  • false — служба доставки не работает в праздничные дни.

  • true — служба доставки работает в праздничные дни.

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

source source Enum

Источник информации о расписании работы службы доставки.

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

  • WEB — информация получена из настроек личного кабинета магазина на Яндекс.Маркете.

  • YML — информация получена из прайс-листа магазина.

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

custom-holidays customHolidays

Список дней, в которые служба доставки не работает. Дни магазин указал в настройках личного кабинета на Яндекс.Маркете.

custom-working-days customWorkingDays

Список выходных и праздничных дней, в которые служба доставки работает. Дни магазин указал в настройках личного кабинета на Яндекс.Маркете.

period period

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

total-holidays totalHolidays

Итоговый список нерабочих дней службы доставки. Список рассчитывается с учетом выходных дней, государственных праздников и нерабочих дней, указанных магазином в личном кабинете на Яндекс.Маркете.

weekly-holidays weeklyHolidays

Список выходных дней недели и государственных праздников.

Параметры, вложенные в custom-holidays / customHolidays

date Date

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

Формат даты: ДД-ММ-ГГГГ.

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

Параметры, вложенные в custom-working-days / customWorkingDays

date Date

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

Формат даты: ДД-ММ-ГГГГ.

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

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

from-date fromDate Date

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

Формат даты: ДД-ММ-ГГГГ.

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

to-date toDate Date

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

Формат даты: ДД-ММ-ГГГГ.

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

Параметры, вложенные в total-holidays / totalHolidays

date Date

Дата нерабочего дня службы доставки.

Формат даты: ДД-ММ-ГГГГ.

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

Параметры, вложенные в weekly-holidays / weeklyHolidays

dow Int8

Номер дня недели.

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

  • 1 — понедельник.

  • 2 — вторник.

  • 3 — среда.

  • 4 — четверг.

  • 5 — пятница.

  • 6 — суббота.

  • 7 — воскресенье.

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

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

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

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

Описание

Пояснение

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

Ошибка 403 Forbidden

Access denied

Нет доступа к магазину.

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

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10001/settings.xml'

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

HTTP/1.1 200 OK
Date: Wed, 07 Jun 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <settings country-region="225" is-online="true" shop-name="Магазин" show-in-context="true" show-in-premium="true" show-in-snippets="true" use-open-stat="false">
    <local-region id="10740" name="Мытищи" type="CITY">
      <delivery>
        <schedule available-on-holidays="false" source="WEB">
          <custom-holidays>
            <date>29-12-2016</date>
          </custom-holidays>
          <custom-working-days/>
          <period from-date="23-12-2016" to-date="10-02-2017"/>
          <total-holidays>
            <date>24-12-2016</date>
            <date>25-12-2016</date>
            <date>28-12-2016</date>
          </total-holidays>
          <weekly-holidays>
            <dow>3</dow>
            <dow>6</dow>
            <dow>7</dow>
          </weekly-holidays>
        </schedule>
      </delivery>
    </local-region>
  </settings>
</response>