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

Info

Console

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
pricing — Управление ценами
pricing:read-only — Просмотр цен
offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
finance-and-accounting — Просмотр финансовой информации и отчётности
communication — Общение с покупателями
settings-management — Настройка магазинов
supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

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

⚙️ Лимит: 1 000 запросов в час

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

блок Идентификатор кампании;
вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

Responses

200 OK

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

Body

application/json

{
    "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

Description

settings

Type: CampaignSettingsDTO

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

CampaignSettingsDTO

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

Name

Description

countryRegion

Type: integer<int64>

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

localRegion

Type: CampaignSettingsLocalRegionDTO

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

shopName

Type: string

Наименование магазина на Яндекс Маркете. Если наименование отсутствует, значение параметра выводится — null.

showInContext

⦸

Type: boolean

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

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

showInPremium

⦸

Type: boolean

Признак показа предложений магазина в блоке над результатами поиска (cпецразмещение). Возможные значения:

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

useOpenStat

⦸

Type: boolean

Признак использования внешней интернет-статистики. Возможные значения:

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

CampaignSettingsLocalRegionDTO

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

Name	Description
delivery	Type: CampaignSettingsDeliveryDTO Информация о доставке в своем регионе магазина.
deliveryOptionsSource	Type: CampaignSettingsScheduleSourceType Источник информации о расписании работы службы доставки. Возможные значения: `WEB` — информация получена из настроек кабинета продавца на Маркете. `YML` — информация получена из прайс-листа магазина. Enum: `WEB`, `YML`
id	Type: integer<int64> Идентификатор региона.
name	Type: string Название региона.
type	Type: RegionType Тип региона. Возможные значения: `CITY_DISTRICT` — район города. `CITY` — крупный город. `CONTINENT` — континент. `COUNTRY_DISTRICT` — область. `COUNTRY` — страна. `REGION` — регион. `REPUBLIC_AREA` — район субъекта федерации. `REPUBLIC` — субъект федерации. `SUBWAY_STATION` — станция метро. `VILLAGE` — город. `OTHER` — неизвестный регион. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

CampaignSettingsDeliveryDTO

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

Name

Description

schedule

Type: CampaignSettingsScheduleDTO

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

CampaignSettingsScheduleSourceType

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

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

Type	Description
CampaignSettingsScheduleSourceType	Enum: `WEB`, `YML`

RegionType

Тип региона.

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

CITY_DISTRICT — район города.
CITY — крупный город.
CONTINENT — континент.
COUNTRY_DISTRICT — область.
COUNTRY — страна.
REGION — регион.
REPUBLIC_AREA — район субъекта федерации.
REPUBLIC — субъект федерации.
SUBWAY_STATION — станция метро.
VILLAGE — город.
OTHER — неизвестный регион.

Type	Description
RegionType	Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`

CampaignSettingsScheduleDTO

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

Name	Description
customHolidays*	Type: string<date-dd-MM-yyyy>[] Список дней, в которые служба доставки не работает. Дни магазин указал в кабинете продавца на Маркете. Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022` Unique items
customWorkingDays*	Type: string<date-dd-MM-yyyy>[] Список выходных и праздничных дней, в которые служба доставки работает. Дни магазин указал в кабинете продавца на Маркете. Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022` Unique items
totalHolidays*	Type: string<date-dd-MM-yyyy>[] Итоговый список нерабочих дней службы доставки. Список рассчитывается с учетом выходных, нерабочих дней и государственных праздников. Информацию по ним магазин указывает в кабинете продавца на Маркете. Формат даты: `ДД-ММ-ГГГГ`. Example: `23-09-2022` Unique items
weeklyHolidays*	Type: integer<int32>[] Список выходных дней недели и государственных праздников. Номер дня недели. Возможные значения: `1` — понедельник. `2` — вторник. `3` — среда. `4` — четверг. `5` — пятница. `6` — суббота. `7` — воскресенье. Для формата JSON выводится номер дня в виде числа. Min value: `1` Max value: `7` Unique items
availableOnHolidays	Type: boolean Признак работы службы доставки в государственные праздники. Возможные значения. `false` — служба доставки не работает в праздничные дни. `true` — служба доставки работает в праздничные дни.
period	Type: CampaignSettingsTimePeriodDTO Период, за который рассчитывается итоговый список нерабочих дней службы доставки.

CampaignSettingsTimePeriodDTO

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

Name

Description

fromDate

Type: string<date-dd-MM-yyyy>

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

Example: 23-09-2022

toDate

Type: string<date-dd-MM-yyyy>

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

Example: 23-09-2022

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Настройки кабинета

Дерево категорий