Настройки магазина
Возвращает информацию о настройках магазина, идентификатор которого указан в запросе.
| ⚙️ Лимит: 1000 запросов в час |
|---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/settings
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
Responses
200 OK
Настройки магазина
Body
{
"settings": {
"countryRegion": 0,
"shopName": "string",
"showInContext": false,
"showInPremium": false,
"useOpenStat": false,
"localRegion": {
"id": 0,
"name": "string",
"type": "OTHER",
"deliveryOptionsSource": "WEB",
"delivery": {
"schedule": {
"availableOnHolidays": false,
"customHolidays": [
"23-09-2022"
],
"customWorkingDays": [
"23-09-2022"
],
"period": {
"fromDate": "23-09-2022",
"toDate": "23-09-2022"
},
"totalHolidays": [
"23-09-2022"
],
"weeklyHolidays": [
0
]
}
}
}
}
}
|
Name |
Type |
Description |
|
settings |
Настройки магазина. |
CampaignSettingsDTO
Настройки магазина.
|
Name |
Type |
Description |
|
countryRegion |
integer<int64> |
Идентификатор региона, в котором находится магазин. |
|
shopName |
string |
Наименование магазина на Яндекс Маркете.
Если наименование отсутствует, значение параметра выводится — |
|
showInContext |
boolean |
Признак размещения магазина на сайтах партнеров Яндекс Дистрибуции. Возможные значения:
|
|
showInPremium |
boolean |
Признак показа предложений магазина в рекламном блоке над результатами поиска (Спецразмещение). Возможные значения:
|
|
useOpenStat |
boolean |
Признак использования внешней интернет-статистики. Возможные значения:
|
|
localRegion |
Информация о своем регионе магазина. |
CampaignSettingsLocalRegionDTO
Информация о своем регионе магазина.
|
Name |
Type |
Description |
|
id |
integer<int64> |
Идентификатор региона. |
|
name |
string |
Название региона. |
|
type |
Тип региона. Возможные значения:
|
|
|
deliveryOptionsSource |
Источник информации о расписании работы службы доставки. Возможные значения:
|
|
|
delivery |
Информация о доставке в своем регионе магазина. |
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT— район города. -
CITY— крупный город. -
CONTINENT— континент. -
COUNTRY_DISTRICT— область. -
COUNTRY— страна. -
REGION— регион. -
REPUBLIC_AREA— район субъекта федерации. -
REPUBLIC— субъект федерации. -
SUBWAY_STATION— станция метро. -
VILLAGE— город. -
OTHER— неизвестный регион.
|
Type |
Description |
|
Enum: |
CampaignSettingsScheduleSourceType
Источник информации о расписании работы службы доставки. Возможные значения:
WEB— информация получена из настроек кабинета продавца на Маркете.YML— информация получена из прайс-листа магазина.
|
Type |
Description |
|
Enum: |
CampaignSettingsDeliveryDTO
Информация о доставке в своем регионе магазина.
|
Name |
Type |
Description |
|
schedule |
Расписание работы службы доставки в своем регионе. |
CampaignSettingsScheduleDTO
Расписание работы службы доставки в своем регионе.
|
Name |
Type |
Description |
|
availableOnHolidays |
boolean |
Признак работы службы доставки в государственные праздники. Возможные значения.
|
|
customHolidays |
string<date-dd-MM-yyyy>[] |
Список дней, в которые служба доставки не работает. Дни магазин указал в кабинете продавца на Маркете.
|
|
customWorkingDays |
string<date-dd-MM-yyyy>[] |
Список выходных и праздничных дней, в которые служба доставки работает. Дни магазин указал в кабинете продавца на Маркете.
|
|
period |
Период, за который рассчитывается итоговый список нерабочих дней службы доставки. |
|
|
totalHolidays |
string<date-dd-MM-yyyy>[] |
Итоговый список нерабочих дней службы доставки. Список рассчитывается с учетом выходных, нерабочих дней и государственных праздников. Информацию по ним магазин указывает в кабинете продавца на Маркете.
|
|
weeklyHolidays |
integer<int32>[] |
Список выходных дней недели и государственных праздников.
|
CampaignSettingsTimePeriodDTO
Период, за который рассчитывается итоговый список нерабочих дней службы доставки.
|
Name |
Type |
Description |
|
fromDate |
string<date-dd-MM-yyyy> |
Дата (включительно) начала периода, по которому рассчитан итоговый список нерабочих дней службы доставки. Формат даты:
|
|
toDate |
string<date-dd-MM-yyyy> |
Дата (включительно) окончания периода, по которому рассчитан итоговый список нерабочих дней службы доставки. Формат даты:
|
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |