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

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

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

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

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

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

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

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

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Responses

200 OK

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

Body

application/json
{
  "settings": {
    "countryRegion": 0,
    "shopName": "example",
    "showInContext": true,
    "showInPremium": true,
    "useOpenStat": true,
    "localRegion": {
      "id": 0,
      "name": "example",
      "type": "OTHER",
      "deliveryOptionsSource": "WEB",
      "delivery": {
        "schedule": {
          "availableOnHolidays": true,
          "customHolidays": [
            null
          ],
          "customWorkingDays": [
            null
          ],
          "period": {},
          "totalHolidays": [
            null
          ],
          "weeklyHolidays": [
            null
          ]
        }
      }
    }
  }
}

Name

Description

settings

Type: CampaignSettingsDTO

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

Example
{
  "countryRegion": 0,
  "shopName": "example",
  "showInContext": true,
  "showInPremium": true,
  "useOpenStat": true,
  "localRegion": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "deliveryOptionsSource": "WEB",
    "delivery": {
      "schedule": {
        "availableOnHolidays": true,
        "customHolidays": [
          "23-09-2022"
        ],
        "customWorkingDays": [
          null
        ],
        "period": {
          "fromDate": null,
          "toDate": null
        },
        "totalHolidays": [
          null
        ],
        "weeklyHolidays": [
          1
        ]
      }
    }
  }
}

RegionType

Тип региона.

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

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

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

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

  • COUNTRY_DISTRICT — область.

  • COUNTRY — страна.

  • REGION — регион.

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

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

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

  • VILLAGE — город.

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

Type: string

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

CampaignSettingsScheduleSourceType

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

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

Type: string

Enum: WEB, YML

DateDdMmYyyy

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

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

Example: 23-09-2022

CampaignSettingsTimePeriodDTO

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

Name

Description

fromDate

Type: DateDdMmYyyy

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

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

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

Example: 23-09-2022

toDate

Type: DateDdMmYyyy

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

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

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

Example: 23-09-2022
Example
{
  "fromDate": "23-09-2022",
  "toDate": null
}

CampaignSettingsScheduleDTO

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

Name

Description

customHolidays

Type: DateDdMmYyyy[]

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

Unique items: true

Example
[
  "23-09-2022"
]

customWorkingDays

Type: DateDdMmYyyy[]

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

Unique items: true

Example
[
  "23-09-2022"
]

totalHolidays

Type: DateDdMmYyyy[]

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

Unique items: true

Example
[
  "23-09-2022"
]

weeklyHolidays

Type: integer[]

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

Unique items: true

Example
[
  1
]

availableOnHolidays

Type: boolean

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

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

period

Type: CampaignSettingsTimePeriodDTO

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

Example
{
  "fromDate": "23-09-2022",
  "toDate": null
}
Example
{
  "availableOnHolidays": true,
  "customHolidays": [
    "23-09-2022"
  ],
  "customWorkingDays": [
    null
  ],
  "period": {
    "fromDate": null,
    "toDate": null
  },
  "totalHolidays": [
    null
  ],
  "weeklyHolidays": [
    1
  ]
}

CampaignSettingsDeliveryDTO

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

Name

Description

schedule

Type: CampaignSettingsScheduleDTO

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

Example
{
  "availableOnHolidays": true,
  "customHolidays": [
    "23-09-2022"
  ],
  "customWorkingDays": [
    null
  ],
  "period": {
    "fromDate": null,
    "toDate": null
  },
  "totalHolidays": [
    null
  ],
  "weeklyHolidays": [
    1
  ]
}
Example
{
  "schedule": {
    "availableOnHolidays": true,
    "customHolidays": [
      "23-09-2022"
    ],
    "customWorkingDays": [
      null
    ],
    "period": {
      "fromDate": null,
      "toDate": null
    },
    "totalHolidays": [
      null
    ],
    "weeklyHolidays": [
      1
    ]
  }
}

CampaignSettingsLocalRegionDTO

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

Name

Description

delivery

Type: CampaignSettingsDeliveryDTO

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

Example
{
  "schedule": {
    "availableOnHolidays": true,
    "customHolidays": [
      "23-09-2022"
    ],
    "customWorkingDays": [
      null
    ],
    "period": {
      "fromDate": null,
      "toDate": null
    },
    "totalHolidays": [
      null
    ],
    "weeklyHolidays": [
      1
    ]
  }
}

deliveryOptionsSource

Type: CampaignSettingsScheduleSourceType

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

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

Enum: WEB, YML

id

Type: integer

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

name

Type: string

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

Example: example

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
Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "deliveryOptionsSource": "WEB",
  "delivery": {
    "schedule": {
      "availableOnHolidays": true,
      "customHolidays": [
        "23-09-2022"
      ],
      "customWorkingDays": [
        null
      ],
      "period": {
        "fromDate": null,
        "toDate": null
      },
      "totalHolidays": [
        null
      ],
      "weeklyHolidays": [
        1
      ]
    }
  }
}

CampaignSettingsDTO

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

Name

Description

countryRegion

Type: integer

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

localRegion

Type: CampaignSettingsLocalRegionDTO

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

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "deliveryOptionsSource": "WEB",
  "delivery": {
    "schedule": {
      "availableOnHolidays": true,
      "customHolidays": [
        "23-09-2022"
      ],
      "customWorkingDays": [
        null
      ],
      "period": {
        "fromDate": null,
        "toDate": null
      },
      "totalHolidays": [
        null
      ],
      "weeklyHolidays": [
        1
      ]
    }
  }
}

shopName

Type: string

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

Example: example

showInContext

Type: boolean

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

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

showInPremium

Type: boolean

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

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

useOpenStat

Type: boolean

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

  • false — внешняя интернет-статистика не используется.
  • true — внешняя интернет-статистика используется.
Example
{
  "countryRegion": 0,
  "shopName": "example",
  "showInContext": true,
  "showInPremium": true,
  "useOpenStat": true,
  "localRegion": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "deliveryOptionsSource": "WEB",
    "delivery": {
      "schedule": {
        "availableOnHolidays": true,
        "customHolidays": [
          "23-09-2022"
        ],
        "customWorkingDays": [
          null
        ],
        "period": {
          "fromDate": null,
          "toDate": null
        },
        "totalHolidays": [
          null
        ],
        "weeklyHolidays": [
          1
        ]
      }
    }
  }
}

400 Bad Request

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

No longer supported, please use an alternative and newer version.

Предыдущая
Настройки кабинета
Следующая
Дерево категорий