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

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

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

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

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

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

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

Min value: 1

Query parameters

Name

Description

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

regionId

Type: integer<int64>

Этот параметр устарел. Для указания региона используйте region_id.

region_id

Type: integer<int64>

Идентификатор региона. Если задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов. Идентификатор региона можно получить c помощью метода GET regions.

shop_outlet_code

Type: string

Идентификатор точки продаж, присвоенный магазином.

Responses

200 OK

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

Body

application/json
{
    "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": "09:59",
                        "endTime": "23:59"
                    }
                ]
            },
            "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

Description

outlets*

Type: FullOutletDTO[]

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

pager

Type: FlippingPagerDTO

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

paging

Type: ScrollingPagerDTO

Информация о страницах результатов.
Ссылка на следующую страницу.

FullOutletDTO

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

Name

Description

address*

Type: OutletAddressDTO

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

id*

Type: integer<int64>

Идентификатор точки продаж, присвоенный Маркетом.

name*

Type: string

Название точки продаж.

phones*

Type: string[]

Номера телефонов точки продаж. Передавайте в формате: +7 (999) 999-99-99.

Min length: 1

Min items: 1

type*

Type: OutletType

Тип точки продаж.

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

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

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

workingSchedule*

Type: OutletWorkingScheduleDTO

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

coords

Type: string

Координаты точки продаж.

Формат: долгота, широта. Разделители: запятая и / или пробел. Например, 20.4522144, 54.7104264.

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

deliveryRules

Type: OutletDeliveryRuleDTO[]

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

Обязательный параметр, если параметр type=DEPOT или type=MIXED.
Информация об условиях доставки для данной точки продаж.

isMain

Type: boolean

Признак основной точки продаж.

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

  • false — неосновная точка продаж.
  • true — основная точка продаж.

moderationReason

Type: string

Статус модерации.

region

Type: RegionDTO

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

shopOutletCode

Type: string

Идентификатор точки продаж, присвоенный магазином.

shopOutletId

Type: string

Идентификатор точки продаж, заданный магазином.

status

Type: OutletStatusType

Статус точки продаж.

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

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

Enum: AT_MODERATION, FAILED, MODERATED, NONMODERATED, UNKNOWN

storagePeriod

Type: integer<int64>

Срок хранения заказа в собственном пункте выдачи заказов. Считается в днях.

visibility

Type: OutletVisibilityType

Состояние точки продаж.

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

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

Enum: HIDDEN, VISIBLE, UNKNOWN

workingTime

Type: string

Рабочее время.

FlippingPagerDTO

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

Name

Description

currentPage

Type: integer<int32>

Текущая страница.

from

Type: integer<int32>

Начальный номер найденного элемента на странице.

pageSize

Type: integer<int32>

Размер страницы.

pagesCount

Type: integer<int32>

Общее количество страниц.

to

Type: integer<int32>

Конечный номер найденного элемента на странице.

total

Type: integer<int32>

Сколько всего найдено элементов.

ScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

prevPageToken

Type: string

Идентификатор предыдущей страницы результатов.

OutletAddressDTO

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

Name

Description

regionId*

Type: integer<int64>

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

Идентификатор можно получить c помощью запроса GET regions.

Внимание

При создании и редактировании точек продаж можно указывать только регионы типов TOWN (город), CITY (крупный город) и REPUBLIC_AREA (район субъекта федерации). Тип региона указан в выходных параметрах type запросов GET regions и GET regions/{regionId}.

additional

Type: string

Дополнительная информация.

block

Type: string

Номер корпуса.

Max length: 16

building

Type: string

Номер строения.

Max length: 16

city

Type: string

Этот параметр устарел. Не используйте его. Город или населенный пункт возвращается в параметре regionId.

Max length: 200

estate

Type: string

Номер владения.

Max length: 16

km

Type: integer<int32>

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

number

Type: string

Номер дома.

Max length: 256

street

Type: string

Улица.

Max length: 512

OutletType

Тип точки продаж.

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

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

Type

Description

OutletType

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

OutletWorkingScheduleDTO

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

Name

Description

scheduleItems*

Type: OutletWorkingScheduleItemDTO[]

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

Min items: 1

workInHoliday

Type: boolean

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

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

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

OutletDeliveryRuleDTO

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

Name

Description

deliveryServiceId

Type: integer<int64>

Идентификатор службы доставки товаров в точку продаж.

Информацию о службе доставки можно получить с помощью запроса GET delivery/services.

maxDeliveryDays

Type: 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.

Max value: 60

minDeliveryDays

Type: 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.

Max value: 60

orderBefore

Type: integer<int32>

Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от minDeliveryDays до maxDeliveryDays.

Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от minDeliveryDays + 1 рабочий день до maxDeliveryDays + 1 рабочий день.

Значение по умолчанию: 24.

Max value: 24

priceFreePickup

Type: number

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

unspecifiedDeliveryInterval

Type: boolean

Признак доставки товаров в точку продаж на заказ.

Признак выставлен, если:

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

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

  • true — товары доставляются в точку продаж на заказ.

Параметр указывается только со значением true.

Взаимоисключающий с параметрами minDeliveryDays и maxDeliveryDays.

RegionDTO

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

Name

Description

name*

Type: string

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

type*

Type: RegionType

Тип региона.

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

children

Type: RegionDTO[]

Дочерние регионы.
Регион доставки.

id

Type: integer<int64>

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

parent

Type: RegionDTO

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

Указываются родительские регионы до уровня страны.

OutletStatusType

Статус точки продаж.

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

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

Type

Description

OutletStatusType

Enum: AT_MODERATION, FAILED, MODERATED, NONMODERATED, UNKNOWN

OutletVisibilityType

Состояние точки продаж.

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

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

Type

Description

OutletVisibilityType

Enum: HIDDEN, VISIBLE, UNKNOWN

OutletWorkingScheduleItemDTO

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

Name

Description

endDay*

Type: DayOfWeekType

Точка продаж работает до указанного дня недели.

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

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

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

endTime*

Type: string

Точка продаж работает до указанного часа.

Формат: ЧЧ:ММ.

Example: 23:59

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

startDay*

Type: DayOfWeekType

Точка продаж работает с указанного дня недели.

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

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

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

startTime*

Type: string

Точка продаж работает c указанного часа.

Формат: ЧЧ:ММ.

Example: 09:59

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

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

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

401 Unauthorized

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR
Предыдущая
Одна точка продаж
Следующая
Создание