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

Метод доступен для модели DBS.

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

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

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

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

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

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

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

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

Количество значений на одной странице.

Min value: 1

page_token

Type: string

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

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

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

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

region_id

Type: integer

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

regionId

Type: integer

Вместо него используйте region_id.

shop_outlet_code

Type: string

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

Example: ``

Responses

200 OK

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

Body

application/json
{
  "outlets": [
    {
      "name": "example",
      "type": "DEPOT",
      "coords": "example",
      "isMain": true,
      "shopOutletCode": "example",
      "visibility": "HIDDEN",
      "address": {
        "regionId": 0,
        "street": "example",
        "number": "example",
        "building": "example",
        "estate": "example",
        "block": "example",
        "additional": "example",
        "km": 0,
        "city": "example"
      },
      "phones": [
        "example"
      ],
      "workingSchedule": {
        "workInHoliday": true,
        "scheduleItems": [
          null
        ]
      },
      "deliveryRules": [
        {}
      ],
      "storagePeriod": 0
    }
  ],
  "paging": {
    "nextPageToken": "example"
  },
  "pager": {
    "total": 0,
    "from": 0,
    "to": 0,
    "currentPage": 0,
    "pagesCount": 0,
    "pageSize": 0
  }
}

Name

Description

outlets

Type: FullOutletDTO[]

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

Example
[
  {
    "name": "example",
    "type": "DEPOT",
    "coords": "example",
    "isMain": true,
    "shopOutletCode": "example",
    "visibility": "HIDDEN",
    "address": {
      "regionId": 0,
      "street": "example",
      "number": "example",
      "building": "example",
      "estate": "example",
      "block": "example",
      "additional": "example",
      "km": 0,
      "city": "example"
    },
    "phones": [
      "example"
    ],
    "workingSchedule": {
      "workInHoliday": true,
      "scheduleItems": [
        {}
      ]
    },
    "deliveryRules": [
      {
        "minDeliveryDays": 0,
        "maxDeliveryDays": 0,
        "deliveryServiceId": 0,
        "orderBefore": 0,
        "priceFreePickup": 0.5,
        "unspecifiedDeliveryInterval": true
      }
    ],
    "storagePeriod": 0
  }
]

pager

Type: FlippingPagerDTO

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

Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

paging

Type: ScrollingPagerDTO

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

Example
{
  "nextPageToken": "example"
}

OutletType

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

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

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

Type: string

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

OutletVisibilityType

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

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

  • HIDDEN — точка продаж выключена.
  • VISIBLE — точка продаж включена.
  • UNKNOWN — неизвестное состояние точки продажи. При определении состояния произошла ошибка.

Type: string

Enum: HIDDEN, VISIBLE, UNKNOWN

OutletAddressDTO

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

Name

Description

regionId

Type: integer

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

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

Типы регионов при создании и редактировании точек продаж

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

additional

Type: string

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

Example: example

block

Type: string

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

Max length: 16

Example: example

building

Type: string

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

Max length: 16

Example: example

city

Type: string

В ответах города и населенные пункты возвращаются в параметре regionId.

Max length: 200

Example: example

estate

Type: string

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

Max length: 16

Example: example

km

Type: integer

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

number

Type: string

Номер дома.

Max length: 256

Example: example

street

Type: string

Улица.

Max length: 512

Example: example
Example
{
  "regionId": 0,
  "street": "example",
  "number": "example",
  "building": "example",
  "estate": "example",
  "block": "example",
  "additional": "example",
  "km": 0,
  "city": "example"
}

DayOfWeekType

День недели:

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

Type: string

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

OutletWorkingScheduleItemDTO

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

Name

Description

endDay

Type: DayOfWeekType

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

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

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

День недели:

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

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

endTime

Type: string

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

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

Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

Example: 23:59

startDay

Type: DayOfWeekType

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

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

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

День недели:

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

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

startTime

Type: string

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

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

Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

Example: 09:59
Example
{
  "startDay": "MONDAY",
  "endDay": null,
  "startTime": "09:59",
  "endTime": "23:59"
}

OutletWorkingScheduleDTO

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

Name

Description

scheduleItems

Type: OutletWorkingScheduleItemDTO[]

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

Min items: 1

Example
[
  {
    "startDay": "MONDAY",
    "endDay": null,
    "startTime": "09:59",
    "endTime": "23:59"
  }
]

workInHoliday

Type: boolean

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

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

  • false — точка продаж не работает в дни государственных праздников.
  • true — точка продаж работает в дни государственных праздников.
Example
{
  "workInHoliday": true,
  "scheduleItems": [
    {
      "startDay": "MONDAY",
      "endDay": null,
      "startTime": "09:59",
      "endTime": "23:59"
    }
  ]
}

OutletDeliveryRuleDTO

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

Name

Description

deliveryServiceId

Type: integer

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

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

maxDeliveryDays

Type: integer

Максимальный срок доставки товаров в точку продаж. Указан в рабочих днях.

Минимальное значение: 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.

Min value: 0

Max value: 60

minDeliveryDays

Type: integer

Минимальный срок доставки товаров в точку продаж. Указан в рабочих днях.

Минимальное значение: 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.

Min value: 0

Max value: 60

orderBefore

Type: integer

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

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

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

Min value: 0

Max value: 24

priceFreePickup

Type: number

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

unspecifiedDeliveryInterval

Type: boolean

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

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

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

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

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

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

Взаимоисключающий с параметрами minDeliveryDays и maxDeliveryDays.
Example
{
  "minDeliveryDays": 0,
  "maxDeliveryDays": 0,
  "deliveryServiceId": 0,
  "orderBefore": 0,
  "priceFreePickup": 0.5,
  "unspecifiedDeliveryInterval": true
}

OutletDTO

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

Name

Description

address

Type: OutletAddressDTO

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

Example
{
  "regionId": 0,
  "street": "example",
  "number": "example",
  "building": "example",
  "estate": "example",
  "block": "example",
  "additional": "example",
  "km": 0,
  "city": "example"
}

name

Type: string

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

Example: example

phones

Type: string[]

Номера телефонов точки продаж. Передавайте номер в формате: +<код страны>(<код города>)<номер>[#<добавочный>].

Примеры:

  • +7 (999) 999-99-99
  • +7 (999) 999-99-99#1234

Min items: 1

Unique items: true

Example
[
  "example"
]

type

Type: OutletType

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

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

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

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

workingSchedule

Type: OutletWorkingScheduleDTO

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

Example
{
  "workInHoliday": true,
  "scheduleItems": [
    {
      "startDay": "MONDAY",
      "endDay": null,
      "startTime": "09:59",
      "endTime": "23:59"
    }
  ]
}

coords

Type: string

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

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

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

Example: example

deliveryRules

Type: OutletDeliveryRuleDTO[] | null

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

Обязательный параметр, если параметр type=DEPOT или type=MIXED.

Min items: 1

Example
[
  {
    "minDeliveryDays": 0,
    "maxDeliveryDays": 0,
    "deliveryServiceId": 0,
    "orderBefore": 0,
    "priceFreePickup": 0.5,
    "unspecifiedDeliveryInterval": true
  }
]

isMain

Type: boolean

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

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

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

shopOutletCode

Type: string

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

Example: example

storagePeriod

Type: integer

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

visibility

Type: OutletVisibilityType

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

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

  • HIDDEN — точка продаж выключена.
  • VISIBLE — точка продаж включена.
  • UNKNOWN — неизвестное состояние точки продажи. При определении состояния произошла ошибка.

Enum: HIDDEN, VISIBLE, UNKNOWN
Example
{
  "name": "example",
  "type": "DEPOT",
  "coords": "example",
  "isMain": true,
  "shopOutletCode": "example",
  "visibility": "HIDDEN",
  "address": {
    "regionId": 0,
    "street": "example",
    "number": "example",
    "building": "example",
    "estate": "example",
    "block": "example",
    "additional": "example",
    "km": 0,
    "city": "example"
  },
  "phones": [
    "example"
  ],
  "workingSchedule": {
    "workInHoliday": true,
    "scheduleItems": [
      {
        "startDay": "MONDAY",
        "endDay": null,
        "startTime": "09:59",
        "endTime": "23:59"
      }
    ]
  },
  "deliveryRules": [
    {
      "minDeliveryDays": 0,
      "maxDeliveryDays": 0,
      "deliveryServiceId": 0,
      "orderBefore": 0,
      "priceFreePickup": 0.5,
      "unspecifiedDeliveryInterval": true
    }
  ],
  "storagePeriod": 0
}

OutletStatusType

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

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

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

Type: string

Enum: AT_MODERATION, FAILED, MODERATED, NONMODERATED, UNKNOWN

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

RegionDTO

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

Name

Description

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

parent

Type: RegionDTO

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

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

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

Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}
Example
{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": {
    "id": 0,
    "name": "example",
    "type": null,
    "parent": null
  }
}

FullOutletDTO

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

Type: object

All of 2 types

  • Type: OutletDTO

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

    Example
    {
  "name": "example",
  "type": "DEPOT",
  "coords": "example",
  "isMain": true,
  "shopOutletCode": "example",
  "visibility": "HIDDEN",
  "address": {
    "regionId": 0,
    "street": "example",
    "number": "example",
    "building": "example",
    "estate": "example",
    "block": "example",
    "additional": "example",
    "km": 0,
    "city": "example"
  },
  "phones": [
    "example"
  ],
  "workingSchedule": {
    "workInHoliday": true,
    "scheduleItems": [
      {
        "startDay": "MONDAY",
        "endDay": null,
        "startTime": "09:59",
        "endTime": "23:59"
      }
    ]
  },
  "deliveryRules": [
    {
      "minDeliveryDays": 0,
      "maxDeliveryDays": 0,
      "deliveryServiceId": 0,
      "orderBefore": 0,
      "priceFreePickup": 0.5,
      "unspecifiedDeliveryInterval": true
    }
  ],
  "storagePeriod": 0
}
  • Type: object

    id

    Type: integer

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

    moderationReason

    Type: string

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

    Example: example

    region

    Type: RegionDTO

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

    Example
    {
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

    shopOutletId

    Type: string

    Вместо него используйте shopOutletCode.

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

    Example: example

    status

    Type: OutletStatusType

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

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

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

    Enum: AT_MODERATION, FAILED, MODERATED, NONMODERATED, UNKNOWN

    workingTime

    Type: string

    Вместо него используйте workingSchedule.

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

    Example: example
    Example
    {
  "id": 0,
  "status": "AT_MODERATION",
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "shopOutletId": "example",
  "workingTime": "example",
  "moderationReason": "example"
}
Example
{
  "name": "example",
  "type": "DEPOT",
  "coords": "example",
  "isMain": true,
  "shopOutletCode": "example",
  "visibility": "HIDDEN",
  "address": {
    "regionId": 0,
    "street": "example",
    "number": "example",
    "building": "example",
    "estate": "example",
    "block": "example",
    "additional": "example",
    "km": 0,
    "city": "example"
  },
  "phones": [
    "example"
  ],
  "workingSchedule": {
    "workInHoliday": true,
    "scheduleItems": [
      {
        "startDay": "MONDAY",
        "endDay": null,
        "startTime": "09:59",
        "endTime": "23:59"
      }
    ]
  },
  "deliveryRules": [
    {
      "minDeliveryDays": 0,
      "maxDeliveryDays": 0,
      "deliveryServiceId": 0,
      "orderBefore": 0,
      "priceFreePickup": 0.5,
      "unspecifiedDeliveryInterval": true
    }
  ],
  "storagePeriod": 0
}

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example
Example
{
  "nextPageToken": "example"
}

ScrollingPagerDTO

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

Type: object

All of 2 types

  • Type: ForwardScrollingPagerDTO

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

    Example
    {
  "nextPageToken": "example"
}
  • Type: object

    prevPageToken

    Type: string

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

    Example: example
    Example
    {
  "prevPageToken": "example"
}
Example
{
  "nextPageToken": "example"
}

FlippingPagerDTO

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

Name

Description

currentPage

Type: integer

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

from

Type: integer

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

pagesCount

Type: integer

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

pageSize

Type: integer

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

to

Type: integer

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

total

Type: integer

Сколько всего найдено элементов.
Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

400 Bad Request

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

Body

application/json
{
  "status": "OK"
}

Type: object

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"
}

401 Unauthorized

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

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json
{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

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

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams:
  - description: "Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.\n\nЕго можно узнать с помощью запроса [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → **Настройки** и в меню слева выберите **API и модули**:\n\n* блок **Идентификатор кампании**;\n* вкладка **Лог запросов** → выпадающий список в блоке **Показывать логи**.\n\n⚠️ Не путайте его с:\n- идентификатором магазина, который отображается в личном кабинете продавца;\n- рекламными кампаниями.\n"
    name: campaignId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams:
  - name: page_token
    description: >
      Идентификатор страницы c результатами.


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


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


      Если задан `page_token` и в запросе есть параметры `page` и `pageSize`,
      они игнорируются.
    in: query
    required: false
    example: eyBuZXh0SWQ6IDIzNDIgfQ==
    schema:
      type: string
  - name: limit
    description: |
      Количество значений на одной странице.
    in: query
    required: false
    example: 20
    schema:
      type: integer
      format: int32
      minimum: 1
  - description: "Идентификатор региона.\nЕсли задать идентификатор родительского региона любого уровня, в выходных данных будут отображены точки продаж всех дочерних регионов.\nИдентификатор региона можно получить c помощью метода [GET\_v2/regions](../../reference/regions/searchRegionsByName.md).\n"
    name: region_id
    in: query
    required: false
    schema:
      type: integer
      format: int64
  - description: Идентификатор точки продаж, присвоенный магазином.
    name: shop_outlet_code
    in: query
    required: false
    schema:
      type: string
  - description: "{% note warning \"Вместо него используйте `region_id`.\" %}\n\n\_\n\n{% endnote %}\n"
    name: regionId
    deprecated: true
    in: query
    required: false
    schema:
      type: integer
      format: int64
headers: []
body: null
schema: {}
method: get
security:
  - type: apiKey
    name: Api-Key
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/outlets
host: https://api.partner.market.yandex.ru

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

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