Регион магазина

Deprecated

Info

Console

Метод доступен для всех моделей.

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

settings-management — Настройка магазинов
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Какой метод использовать вместо устаревшего

GET campaigns/{campaignId}/settings

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

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

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

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

Модули и API → блок Передача данных Маркету.
Лог запросов → выпадающий список в блоке Показывать логи.

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

Min value: 1

Responses

200 OK

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

Body

application/json

{
    "region": {
        "id": 0,
        "name": "string",
        "type": "OTHER",
        "parent": {
            "id": 0,
            "name": "string",
            "type": "OTHER",
            "children": [
                null
            ]
        },
        "children": [
            null
        ]
    }
}

Name

Description

region

Type: RegionDTO

Регион доставки.

RegionDTO

Регион доставки.

Name	Description
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`
children	Type: RegionDTO[] Дочерние регионы. Регион доставки. Min items: `1`
parent	Type: RegionDTO Информация о родительском регионе. Указываются родительские регионы до уровня страны.

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`

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

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

Список складов

Одна модель