Request
- Path parameters
- Query parameters
Responses
200 OK
400 Bad Request
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

Информация о точках продаж

Info

Console

Возвращает список точек продаж магазина.

В течение суток этим и другими запросами о точках продаж, кроме запроса GET delivery/services, можно получить и изменить информацию об определенном суммарном количестве точек продаж. Оно зависит от количества точек продаж магазина.

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

Request

GET

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

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Query parameters

Name	Type	Description
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются. Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`
region_id	integer<int64>	Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода GET regions.
shop_outlet_code	string	Идентификатор точки продаж, присвоенный магазином.
regionId	integer<int64>	Внимание Параметр устарел и не рекомендуется к использованию. Идентификатор региона укажите в параметре `region_id`.

{
    "outlets": [
        {
            "name": "string",
            "type": "DEPOT",
            "coords": "string",
            "isMain": false,
            "shopOutletCode": "string",
            "visibility": "HIDDEN",
            "address": {
                "regionId": 0,
                "street": "string",
                "number": "string",
                "building": "string",
                "estate": "string",
                "block": "string",
                "additional": "string",
                "km": 0,
                "city": "string"
            },
            "phones": [
                "string"
            ],
            "workingSchedule": {
                "workInHoliday": false,
                "scheduleItems": [
                    {
                        "startDay": "MONDAY",
                        "endDay": "MONDAY",
                        "startTime": "string",
                        "endTime": "string"
                    }
                ]
            },
            "deliveryRules": [
                {
                    "minDeliveryDays": 0,
                    "maxDeliveryDays": 0,
                    "deliveryServiceId": 0,
                    "orderBefore": 0,
                    "priceFreePickup": 0,
                    "unspecifiedDeliveryInterval": false
                }
            ],
            "storagePeriod": 0,
            "id": 0,
            "status": "AT_MODERATION",
            "region": {
                "id": 0,
                "name": "string",
                "type": "OTHER",
                "parent": {
                    "id": 0,
                    "name": "string",
                    "type": "OTHER",
                    "children": [
                        null
                    ]
                },
                "children": [
                    null
                ]
            },
            "shopOutletId": "string",
            "workingTime": "string",
            "moderationReason": "string"
        }
    ],
    "paging": {
        "nextPageToken": "string",
        "prevPageToken": "string"
    },
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name	Type	Description
outlets	FullOutletDTO[]	Информация о точках продаж. Информация о точке продаж. Информация о точке продаж.
paging	ScrollingPagerDTO	Информация о страницах результатов. Ссылка на следующую страницу.
pager	FlippingPagerDTO	Модель для пагинации.

FullOutletDTO

Информация о точке продаж.

Name	Type	Description
name*	string	Название точки продаж.
type*	OutletType	Тип точки продаж. Возможные значения: `DEPOT` — пункт выдачи заказов. `MIXED` — смешанный тип точки продаж (торговый зал и пункт выдачи заказов). `RETAIL` — розничная точка продаж (торговый зал). Enum: `DEPOT`, `MIXED`, `RETAIL`, `NOT_DEFINED`
coords	string	Координаты точки продаж. Формат: долгота, широта. Разделители: запятая и / или пробел. Например, `20.4522144, 54.7104264`. Если параметр не передан, координаты будут определены по значениям параметров, вложенных в `address`.
isMain	boolean	Признак основной точки продаж. Возможные значения: `false` — неосновная точка продаж. `true` — основная точка продаж.
shopOutletCode	string	Идентификатор точки продаж, присвоенный магазином.
visibility	OutletVisibilityType	Состояние точки продаж. Возможные значения: `HIDDEN` — точка продаж выключена. `VISIBLE` — точка продаж включена. Enum: `HIDDEN`, `VISIBLE`, `UNKNOWN`
address*	OutletAddressDTO	Адрес точки продаж.
phones*	string[]	Номера телефонов точки продаж. Передавайте в формате: `+7 (999) 999-99-99`. Min length: `1`
workingSchedule*	OutletWorkingScheduleDTO	Список режимов работы точки продаж.
deliveryRules	OutletDeliveryRuleDTO[]	Информация об условиях доставки для данной точки продаж. Обязательный параметр, если параметр `type=DEPOT` или `type=MIXED`. Информация об условиях доставки для данной точки продаж.
storagePeriod	integer<int64>	Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях.
id	integer<int64>	Идентификатор точки продаж, присвоенный Яндекс Маркетом.
status	OutletStatusType	Статус точки продаж. Возможные значения: `AT_MODERATION` — проверяется. `FAILED` — не прошла проверку и отклонена модератором. `MODERATED` — проверена и одобрена. `NONMODERATED` — новая точка, нуждается в проверке. Enum: `AT_MODERATION`, `FAILED`, `MODERATED`, `NONMODERATED`, `UNKNOWN`
region	RegionDTO	Регион доставки.
shopOutletId	string	Идентификатор точки продаж, заданный магазином.
workingTime	string	Рабочее время.
moderationReason	string	Статус модерации.

ScrollingPagerDTO

Информация о страницах результатов.

Name	Type	Description
nextPageToken	string	Идентификатор следующей страницы результатов.
prevPageToken	string	Идентификатор предыдущей страницы результатов.

FlippingPagerDTO

Модель для пагинации.

Name	Type	Description
total	integer<int32>	Сколько всего найдено элементов.
from	integer<int32>	Начальный номер найденного элемента на странице.
to	integer<int32>	Конечный номер найденного элемента на странице.
currentPage	integer<int32>	Текущая страница.
pagesCount	integer<int32>	Общее количество страниц.
pageSize	integer<int32>	Размер страницы.

OutletType

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

DEPOT — пункт выдачи заказов.
MIXED — смешанный тип точки продаж (торговый зал и пункт выдачи заказов).
RETAIL — розничная точка продаж (торговый зал).

Type	Description
OutletType	Enum: `DEPOT`, `MIXED`, `RETAIL`, `NOT_DEFINED`

OutletVisibilityType

Состояние точки продаж. Возможные значения:

HIDDEN — точка продаж выключена.
VISIBLE — точка продаж включена.

Type	Description
OutletVisibilityType	Enum: `HIDDEN`, `VISIBLE`, `UNKNOWN`

OutletAddressDTO

Адрес точки продаж.

Name	Type	Description
regionId*	integer<int64>	Идентификатор региона. Идентификатор можно получить c помощью запроса GET regions. Внимание При создании и редактировании точек продаж можно указывать только регионы типов `TOWN` (город), `CITY` (крупный город) и `REPUBLIC_AREA` (район субъекта федерации). Тип региона указан в выходных параметрах type запросов GET regions и GET regions/{regionId}.
street	string	Улица. Max length: `512`
number	string	Номер дома. Max length: `256`
building	string	Номер строения. Max length: `16`
estate	string	Номер владения. Max length: `16`
block	string	Номер корпуса. Max length: `16`
additional	string	Дополнительная информация.
km	integer<int32>	Порядковый номер километра дороги, на котором располагается точка продаж, если отсутствует улица.
city	string	Внимание Параметр устарел и не рекомендуется к использованию. Город или населенный пункт возвращается в параметре `regionId`. Max length: `200`

OutletWorkingScheduleDTO

Список режимов работы точки продаж.

Name

Type

Description

workInHoliday

boolean

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

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

scheduleItems*

OutletWorkingScheduleItemDTO[]

Список расписаний работы точки продаж.
Расписание работы точки продаж.

OutletDeliveryRuleDTO

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

Name	Type	Description
minDeliveryDays	integer<int32>	Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях. Минимальное значение: `0` — доставка в день заказа. Максимальное значение: `60`. Допустимые сроки доставки (разница между `minDeliveryDays` и `maxDeliveryDays`) зависят от региона. Для доставки по своему региону разница не должна превышать двух дней. Например, если `minDeliveryDays` равно 1, то для `maxDeliveryDays` допускаются значения от 1 до 3. Для доставки в другие регионы: Если `minDeliveryDays` до 18 дней, разница не должна превышать четырех дней. Например, если `minDeliveryDays` равно 10, то для `maxDeliveryDays` допускаются значения от 10 до 14. Если `minDeliveryDays` больше 18 дней, разница должна быть не больше чем в два раза. Например, если `minDeliveryDays` равно 21, то для `maxDeliveryDays` допускаются значения от 21 до 42. Обязательный параметр, если `type="DEPOT"` или `type="MIXED"`. Взаимоисключающий с параметром `unspecifiedDeliveryInterval`.
maxDeliveryDays	integer<int32>	Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях. Минимальное значение: `0` — доставка в день заказа. Максимальное значение: `60`. Допустимые сроки доставки (разница между `minDeliveryDays` и `maxDeliveryDays`) зависят от региона. Для доставки по своему региону разница не должна превышать двух дней. Например, если `minDeliveryDays` равно 1, то для `maxDeliveryDays` допускаются значения от 1 до 3. Для доставки в другие регионы: Если `minDeliveryDays` до 18 дней, разница не должна превышать четырех дней. Например, если `minDeliveryDays` равно 10, то для `maxDeliveryDays` допускаются значения от 10 до 14. Если `minDeliveryDays` больше 18 дней, разница должна быть не больше чем в два раза. Например, если `minDeliveryDays` равно 21, то для `maxDeliveryDays` допускаются значения от 21 до 42. Обязательный параметр, если `type="DEPOT"` или `type="MIXED"`. Взаимоисключающий с параметром `unspecifiedDeliveryInterval`.
deliveryServiceId	integer<int64>	Идентификатор службы доставки товаров в точку продаж. Информацию о службе доставки можно получить с помощью запроса GET delivery/services.
orderBefore	integer<int32>	Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от `minDeliveryDays` до `maxDeliveryDays`. Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от `minDeliveryDays` + 1 рабочий день до `maxDeliveryDays` + 1 рабочий день. Значение по умолчанию: `24`.
priceFreePickup	number	Цена товара, начиная с которой действует бесплатный самовывоз товара из точки продаж.
unspecifiedDeliveryInterval	boolean	Признак доставки товаров в точку продаж на заказ. Признак выставлен, если: точный срок доставки в точку продаж заранее неизвестен (например, если магазин собирает несколько заказов для отправки в точку или населенный пункт); все товары изготавливаются или поставляются на заказ. Возможные значения: `true` — товары доставляются в точку продаж на заказ. Параметр указывается только со значением `true`. Взаимоисключающий с параметрами `minDeliveryDays` и `maxDeliveryDays`.

OutletStatusType

Статус точки продаж. Возможные значения:

AT_MODERATION — проверяется.
FAILED — не прошла проверку и отклонена модератором.
MODERATED — проверена и одобрена.
NONMODERATED — новая точка, нуждается в проверке.

Type	Description
OutletStatusType	Enum: `AT_MODERATION`, `FAILED`, `MODERATED`, `NONMODERATED`, `UNKNOWN`

RegionDTO

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

Name	Type	Description
id	integer<int64>	Идентификатор региона.
name*	string	Название региона.
type*	RegionType	Тип региона. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
parent	RegionDTO	Информация о родительском регионе. Указываются родительские регионы до уровня страны.
children	RegionDTO[]	Дочерние регионы. Регион доставки.

OutletWorkingScheduleItemDTO

Расписание работы точки продаж.

Name	Type	Description
startDay*	DayOfWeekType	Точка продаж работает с указанного дня недели. Возможные значения: `MONDAY` — понедельник. `TUESDAY` — вторник. `WEDNESDAY` — среда. `THURSDAY` — четверг. `FRIDAY` — пятница. `SATURDAY` — суббота. `SUNDAY` — воскресенье. Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`
endDay*	DayOfWeekType	Точка продаж работает до указанного дня недели. Возможные значения: `MONDAY` — понедельник. `TUESDAY` — вторник. `WEDNESDAY` — среда. `THURSDAY` — четверг. `FRIDAY` — пятница. `SATURDAY` — суббота. `SUNDAY` — воскресенье. Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`
startTime*	string	Точка продаж работает c указанного часа. Формат: `ЧЧ:ММ`. Min length: `1`
endTime*	string	Точка продаж работает до указанного часа. Формат: `ЧЧ:ММ`. Min length: `1`

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`

DayOfWeekType

День недели:

MONDAY — понедельник.
TUESDAY — вторник.
WEDNESDAY — среда.
THURSDAY — четверг.
FRIDAY — пятница.
SATURDAY — суббота.
SUNDAY — воскресенье.

Type	Description
DayOfWeekType	Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`

400 Bad Request

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

ApiResponseStatusType

Тип ответа.

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

ApiErrorDTO

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

Name	Type	Description
code*	string	Код ошибки.
message	string	Описание ошибки.

401 Unauthorized

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

403 Forbidden

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

404 Not Found

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

420 Method Failure

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

Информация о точках продаж

RequestRequest

Path parametersPath parameters

Query parametersQuery parameters

ResponsesResponses

200 OK200 OK

BodyBody

FullOutletDTOFullOutletDTO

ScrollingPagerDTOScrollingPagerDTO

FlippingPagerDTOFlippingPagerDTO

OutletTypeOutletType

OutletVisibilityTypeOutletVisibilityType

OutletAddressDTOOutletAddressDTO

OutletWorkingScheduleDTOOutletWorkingScheduleDTO

OutletDeliveryRuleDTOOutletDeliveryRuleDTO

OutletStatusTypeOutletStatusType

RegionDTORegionDTO

OutletWorkingScheduleItemDTOOutletWorkingScheduleItemDTO

RegionTypeRegionType

DayOfWeekTypeDayOfWeekType

400 Bad Request400 Bad Request

BodyBody

ApiResponseStatusTypeApiResponseStatusType

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

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

Request

Path parameters

Query parameters

Responses

200 OK

Body

FullOutletDTO

ScrollingPagerDTO

FlippingPagerDTO

OutletType

OutletVisibilityType

OutletAddressDTO

OutletWorkingScheduleDTO

OutletDeliveryRuleDTO

OutletStatusType

RegionDTO

OutletWorkingScheduleItemDTO

RegionType

DayOfWeekType

400 Bad Request

Body

ApiResponseStatusType

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body