Информация о точках продаж
Возвращает список точек продаж магазина.
В течение суток этим и другими запросами о точках продаж, кроме запроса 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 результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
region_id |
integer<int64> |
Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода GET regions. |
shop_outlet_code |
string |
Идентификатор точки продаж, присвоенный магазином. |
regionId |
integer<int64> |
Внимание Параметр устарел и не рекомендуется к использованию. Идентификатор региона укажите в параметре |
Responses
200 OK
Информация о точках продаж.
Body
{
"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 |
Информация о точках продаж. |
|
paging |
Информация о страницах результатов. |
|
pager |
Модель для пагинации. |
FullOutletDTO
Информация о точке продаж.
Name |
Type |
Description |
name* |
string |
Название точки продаж. |
type* |
Тип точки продаж. Возможные значения:
|
|
coords |
string |
Координаты точки продаж. Формат: долгота, широта. Разделители: запятая и / или пробел. Например, Если параметр не передан, координаты будут определены по значениям параметров, вложенных в |
isMain |
boolean |
Признак основной точки продаж. Возможные значения:
|
shopOutletCode |
string |
Идентификатор точки продаж, присвоенный магазином. |
visibility |
Состояние точки продаж. Возможные значения:
|
|
address* |
Адрес точки продаж. |
|
phones* |
string[] |
Номера телефонов точки продаж. Передавайте в формате: |
workingSchedule* |
Список режимов работы точки продаж. |
|
deliveryRules |
Информация об условиях доставки для данной точки продаж.
Обязательный параметр, если параметр |
|
storagePeriod |
integer<int64> |
Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях. |
id |
integer<int64> |
Идентификатор точки продаж, присвоенный Яндекс Маркетом. |
status |
Статус точки продаж. Возможные значения:
|
|
region |
Регион доставки. |
|
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 |
Enum: |
OutletVisibilityType
Состояние точки продаж. Возможные значения:
HIDDEN
— точка продаж выключена.VISIBLE
— точка продаж включена.
Type |
Description |
Enum: |
OutletAddressDTO
Адрес точки продаж.
Name |
Type |
Description |
regionId* |
integer<int64> |
Идентификатор региона. Идентификатор можно получить c помощью запроса GET regions. Внимание При создании и редактировании точек продаж можно указывать только регионы типов |
street |
string |
Улица.
|
number |
string |
Номер дома.
|
building |
string |
Номер строения.
|
estate |
string |
Номер владения.
|
block |
string |
Номер корпуса.
|
additional |
string |
Дополнительная информация. |
km |
integer<int32> |
Порядковый номер километра дороги, на котором располагается точка продаж, если отсутствует улица. |
city |
string |
Внимание Параметр устарел и не рекомендуется к использованию. Город или населенный пункт возвращается в параметре
|
OutletWorkingScheduleDTO
Список режимов работы точки продаж.
Name |
Type |
Description |
workInHoliday |
boolean |
Признак, работает ли точка продаж в дни государственных праздников. Возможные значения:
|
scheduleItems* |
Список расписаний работы точки продаж.
|
OutletDeliveryRuleDTO
Информация об условиях доставки для данной точки продаж.
Name |
Type |
Description |
minDeliveryDays |
integer<int32> |
Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях.
Минимальное значение:
|
maxDeliveryDays |
integer<int32> |
Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях.
Минимальное значение:
|
deliveryServiceId |
integer<int64> |
Идентификатор службы доставки товаров в точку продаж. Информацию о службе доставки можно получить с помощью запроса GET delivery/services. |
orderBefore |
integer<int32> |
Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от |
priceFreePickup |
number |
Цена товара, начиная с которой действует бесплатный самовывоз товара из точки продаж. |
unspecifiedDeliveryInterval |
boolean |
Признак доставки товаров в точку продаж на заказ. Признак выставлен, если:
|
OutletStatusType
Статус точки продаж. Возможные значения:
AT_MODERATION
— проверяется.FAILED
— не прошла проверку и отклонена модератором.MODERATED
— проверена и одобрена.NONMODERATED
— новая точка, нуждается в проверке.
Type |
Description |
Enum: |
RegionDTO
Регион доставки.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор региона. |
name* |
string |
Название региона. |
type* |
Тип региона.
|
|
parent |
Информация о родительском регионе. Указываются родительские регионы до уровня страны. |
|
children |
Дочерние регионы. |
OutletWorkingScheduleItemDTO
Расписание работы точки продаж.
Name |
Type |
Description |
startDay* |
Точка продаж работает с указанного дня недели. Возможные значения:
|
|
endDay* |
Точка продаж работает до указанного дня недели. Возможные значения:
|
|
startTime* |
string |
Точка продаж работает c указанного часа.
Формат:
|
endTime* |
string |
Точка продаж работает до указанного часа.
Формат:
|
RegionType
Тип региона.
Возможные значения:
-
CITY_DISTRICT
— район города. -
CITY
— крупный город. -
CONTINENT
— континент. -
COUNTRY_DISTRICT
— область. -
COUNTRY
— страна. -
REGION
— регион. -
REPUBLIC_AREA
— район субъекта федерации. -
REPUBLIC
— субъект федерации. -
SUBWAY_STATION
— станция метро. -
VILLAGE
— город. -
OTHER
— неизвестный регион.
Type |
Description |
Enum: |
DayOfWeekType
День недели:
MONDAY
— понедельник.TUESDAY
— вторник.WEDNESDAY
— среда.THURSDAY
— четверг.FRIDAY
— пятница.SATURDAY
— суббота.SUNDAY
— воскресенье.
Type |
Description |
Enum: |
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 |
Список ошибок. |