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

Описание

GET /campaigns/{campaignId}/outlets

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

Примечание. Метод доступен начиная с версии 2.4 партнерского API Яндекс.Маркета.

URL ресурса:

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

Входные данные

Параметр

Тип

Значение

Обязательные

campaignId

Int64

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

Необязательные

page

Int32

Номер страницы результатов, которую необходимо показать в ответе.

Если указан номер страницы, превышающий общее количество найденных страниц, выдаются результаты по последней странице.

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

Максимальное значение: 50.

pageSize

Int32

Количество результатов на странице.

Значение по умолчанию и максимально возможное значение: 50.

region_id

Int64

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

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

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

shop_outlet_code

String

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

regionId

Int64
Внимание. Параметр устарел и не рекомендуется к использованию. Идентификатор региона укажите в параметре region_id.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<response>
  <outlets>
    <outlet coords="{string}" id="{int64}" is-main="{boolean}" name="{string}" reason="{string}" shop-outlet-code="{string}" status="{enum}" type="{enum}" visibility="{enum}" is-book-now="{boolean}" shop-outlet-id="{string}" working-time="{string}">
      <address region-id="{int64}" street="{string}" number="{string}" building="{string}" estate="{string}" block="{string}" additional="{string}" km="{integer}" city="{string}"/>
      <delivery-rules>
        <delivery-rule cost="{double}" min-delivery-days="{int32}" max-delivery-days="{int32}" delivery-service-id="{int64}" order-before="{int32}" price-free-pickup="{double}" unspecified-delivery-interval="{boolean}" date-switch-hour="{int32}" price-from="{double}" price-to="{double}" shipper-human-readable-id="{string}" shipper-id="{int64}" shipper-name="{string}" work-in-holiday="{boolean}"/>
      </delivery-rules>
      <emails>
        <email>{string}</email>
      </emails>
      <phones>
        <phone>{string}</phone>
        ...
      </phones>
      <region id="{int64}" name="{string}" type="{enum}">
        <parent id="{int64}" name="{string}" type="{enum}">
          ...
        </parent>
      </region>
      <working-schedule work-in-holiday="{boolean}">
        <schedule-items>
          <schedule-item start-day="{enum}" end-day="{enum}" start-time="{string}" end-time="{string}"/>
          ...
        </schedule-items>
      </working-schedule>
    </outlet>
    ...
  </outlets>
  <pager current-page="{int32}" from="{int32}" page-size="{int32}" to="{int32}"/>
</response>

Описание параметров:

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

response

Ответ.

Параметр выводится только для формата XML.

Параметры, вложенные в response

outletsoutlets

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

pagerpager

Сводка по результатам поиска.

Параметры, вложенные в outlets

outlet

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

Параметр выводится только для формата XML.

Параметры, вложенные в outlet / outlets

coordscoordsString

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

Формат: долгота, широта. Например, 20.4522144, 54.7104264.

Для формата XML является атрибутом параметра outlet.

ididInt64

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

Для формата XML является атрибутом параметра outlet.

is-mainisMainBoolean

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

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

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

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

Для формата XML является атрибутом параметра outlet.

namenameString

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

Для формата XML является атрибутом параметра outlet.

reasonreasonString

Причина отклонения точки продаж.

Параметр выводится, если параметр status=FAILED.

Для формата XML является атрибутом параметра outlet.

shop-outlet-codeshopOutletCodeString

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

Для формата XML является атрибутом параметра outlet.

statusstatusEnum

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

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

  • AT_MODERATION — проверяется.

  • FAILED — не прошла проверку и отклонена модератором.

  • MODERATED — проверена и одобрена.

  • NONMODERATED — новая точка, нуждается в проверке.

Для формата XML является атрибутом параметра outlet.

typetypeEnum

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

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

  • DEPOT — пункт выдачи заказов.

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

  • NOT_DEFINED — тип точки продаж не определен.

  • RETAIL — розничная точка продаж (торговый зал).

Для формата XML является атрибутом параметра outlet.

visibilityvisibilityEnum

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

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

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

  • UNKNOWN — состояние точки продаж неизвестно.

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

Для формата XML является атрибутом параметра outlet.

is-book-nowisBookNowBoolean
Внимание. Параметр устарел и не рекомендуется к использованию.
shop-outlet-idshopOutletIdString
Внимание. Параметр устарел и не рекомендуется к использованию. Идентификатор точки продаж, присвоенный магазином, возвращается в параметре shop-outlet-code.
working-timeworkingTimeString
Внимание. Параметр устарел и не рекомендуется к использованию. Режим работы возвращается в параметре working-schedule.
addressaddress

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

delivery-rulesdeliveryRules

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

emailsemails

Адрес электронной почты точки продаж.

Может содержать только один параметр email.

phonesphones

Номера телефонов точки продаж.

regionregion

Регион точки продаж.

working-scheduleworkingSchedule

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

Параметры, вложенные в address

region-idregionIdInt64

Идентификатор города или населенного пункта.

Для формата XML является атрибутом параметра address.

streetstreetString

Улица.

Для формата XML является атрибутом параметра address.

numbernumberString

Номер дома.

Для формата XML является атрибутом параметра address.

buildingbuildingString

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

Для формата XML является атрибутом параметра address.

estateestateString

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

Для формата XML является атрибутом параметра address.

blockblockString

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

Для формата XML является атрибутом параметра address.

additionaladditionalString

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

Для формата XML является атрибутом параметра address.

kmkmInteger

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

Для формата XML является атрибутом параметра address.

citycityString
Внимание. Параметр устарел и не рекомендуется к использованию. Город или населенный пункт возвращается в параметре region-id.

Параметры, вложенные в delivery-rules

delivery-rule

Условие доставки для данной точки продаж.

Параметры, вложенные в delivery-rule / deliveryRules

costcostDouble

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

Для формата XML является атрибутом параметра delivery-rule.

min-delivery-daysminDeliveryDaysInt32

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

Для формата XML является атрибутом параметра delivery-rule.

max-delivery-daysmaxDeliveryDaysInt32

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

Для формата XML является атрибутом параметра delivery-rule.

delivery-service-iddeliveryServiceIdInt64

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

Для формата XML является атрибутом параметра delivery-rule.

order-beforeorderBeforeInt32

Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж в сроки от min-delivery-days до max-delivery-days.

Если покупатель оформит заказ после указанного часа, он будет доставлен в сроки от min-delivery-days + 1 рабочий день до max-delivery-days + 1 рабочий день.

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

Для формата XML является атрибутом параметра delivery-rule.

price-free-pickuppriceFreePickupDouble

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

Для формата XML является атрибутом параметра delivery-rule.

unspecified-delivery-intervalunspecifiedDeliveryIntervalBoolean

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

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

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

  • все товары изготавливаются или поставляются на заказ.

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

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

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

Для формата XML является атрибутом параметра delivery-rule.

date-switch-hourdateSwitchHourInt32
Внимание. Параметр устарел и не рекомендуется к использованию. Час, до которого покупателю нужно сделать заказ, чтобы он был доставлен в точку продаж, возвращается в параметре order-before.
price-frompriceFromDouble
Внимание. Параметр устарел и не рекомендуется к использованию.
price-topriceToDouble
Внимание. Параметр устарел и не рекомендуется к использованию. Цена товара, начиная с которой действует бесплатный самовывоз возвращается в параметре price-free-pickup.
shipper-human-readable-idshipperHumanReadableIdString
Внимание. Параметр устарел и не рекомендуется к использованию.
shipper-idshipperIdInt64
Внимание. Параметр устарел и не рекомендуется к использованию. Идентификатор службы доставки товаров в точку продаж возвращается в параметре delivery-service-id.
shipper-nameshipperNameString
Внимание. Параметр устарел и не рекомендуется к использованию.
work-in-holidayworkInHolidayBoolean
Внимание. Параметр устарел и не рекомендуется к использованию. Признак, работает ли точка продаж в дни государственных праздников возвращается в параметре working-schedule work-in-holiday.

Параметры, вложенные в emails

emailString

Адрес электронной почты точки продаж.

Допускается любой адрес электронной почты, соответствующий стандарту RFC 2822.

Для формата JSON выводится в виде строки.

Параметры, вложенные в phones

phoneString

Номер телефона точки продаж.

Формат: + код страны (код города) телефон #добавочный. Например, +7 (495) 012-34-56 #789.

Для формата JSON выводится в виде строки.

Параметры, вложенные в region

ididInt64

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

Для формата XML является атрибутом параметра region.

namenameString

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

Для формата XML является атрибутом параметра region.

typetypeEnum

Тип региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра region.

parentparent

Родительский регион.

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

Параметры, вложенные в parent

ididInt64

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

Для формата XML является атрибутом параметра parent.

namenameString

Название родительского региона.

Для формата XML является атрибутом параметра parent.

typetypeEnum

Тип родительского региона.

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

  • AREA — область.

  • CITY — крупный город.

  • CONTINENT — континент.

  • COUNTRY — страна.

  • DISCTRICT — район города.

  • MONORAIL_STATION — станция монорельса.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • REGION — регион.

  • REPUBLIC — субъект федерации.

  • REPUBLIC_AREA — район субъекта федерации.

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • SETTLEMENT — поселение.

  • SUBURB — пригород.

  • SUBWAY_STATION — станция метро.

  • TOWN — город.

  • UNKNOWN — неизвестный регион.

Для формата XML является атрибутом параметра parent.

parentparent

Рекурсивно вложенный элемент для указания родительских регионов более высокого уровня.

Параметры, вложенные в working-schedule / workingSchedule

work-in-holidayworkInHolidayBoolean

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

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

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

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

Для формата XML является атрибутом параметра working-schedule.

schedule-itemsscheduleItems

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

Параметры, вложенные в schedule-items

schedule-item

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

Параметр выводится только для формата XML.

Параметры, вложенные в schedule-item / scheduleItems

start-daystartDayEnum

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

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

  • MONDAY — понедельник.

  • TUESDAY — вторник.

  • WEDNESDAY — среда.

  • THURSDAY — четверг.

  • FRIDAY — пятница.

  • SATURDAY — суббота.

  • SUNDAY — воскресенье.

Для формата XML является атрибутом параметра schedule-item.

end-dayendDayEnum

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

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

  • MONDAY — понедельник.

  • TUESDAY — вторник.

  • WEDNESDAY — среда.

  • THURSDAY — четверг.

  • FRIDAY — пятница.

  • SATURDAY — суббота.

  • SUNDAY — воскресенье.

Для формата XML является атрибутом параметра schedule-item.

start-timestartTimeString

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

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

Для формата XML является атрибутом параметра schedule-item.

end-timeendTimeString

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

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

Для формата XML является атрибутом параметра schedule-item.

Параметры, вложенные в pager

current-pagecurrentPageInt32

Порядковый номер текущей страницы результатов.

Для формата XML является атрибутом параметра pager.

fromfromInt32

Порядковый номер первой записи на странице относительно общих результатов поиска.

Если ничего не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

page-sizepageSizeInt32

Количество записей на текущей странице.

Если ничего не найдено, значение параметра: 0.

До версии 2.0 партнерского API Яндекс.Маркета параметр назывался page-offers.

Для формата XML является атрибутом параметра pager.

totoInt32

Порядковый номер последней записи на странице относительно общих результатов поиска.

Если ничего не найдено, значение параметра: 0.

Для формата XML является атрибутом параметра pager.

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

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 400 Bad Request

Page size is too big: 'pageSize'. Max page size is 'maxPageSize'

Указан слишком большой размер страницы.

Проверьте корректность передаваемого размера страницы.

Page size must be positive: 'pageSize'

Размер страницы должен быть положительным числом.

Проверьте корректность передаваемого размера страницы.

Ошибка 403 Forbidden

Access denied

Нет доступа к магазину.

Проверьте корректность идентификатора магазина.

Ошибка 404 Not Found

Resource not found

Идентификатор магазина, переданный в path-параметре campaignId, не существует в Яндекс.Маркете.

Проверьте корректность передаваемых данных.

Ограничения

Для методов DELETE /campaigns/{campaignId}/outlets/{outletId}, GET /campaigns/{campaignId}/outlets, GET /campaigns/{campaignId}/outlets/{outletId}, POST /campaigns/{campaignId}/outlets и PUT /campaigns/{campaignId}/outlets/{outletId} действует групповое ресурсное ограничение.

Ограничение вводится на суммарное количество точек продаж, информация по которым получена или передана при помощи этих методов. Объем запросов к ресурсу, который возможно выполнить в течение суток, рассчитывается индивидуально и зависит от следующих показателей:

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

Примеры

Пример запроса:

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/12345/outlets.xml'

Пример ответа:

HTTP/1.1 200 OK
Date: Tue, 25 Jul 2017 00:42:42 GMT
Content-Type: application/xml;charset=utf-8
...

<response>
  <outlets>
    <outlet coords="20.4522144, 54.7104264" id="171819" is-main="false" name="На Озёрной" shop-outlet-code="419" status="AT_MODERATION" type="DEPOT" visibility="VISIBLE">
      <address region-id="22" street="ОЗЕРНАЯ" number="20А"/>
      <delivery-rules>
        <delivery-rule cost="285" min-delivery-days="19" max-delivery-days="30" delivery-service-id="100" order-before="24" price-free-pickup="120" unspecified-delivery-interval="true"/>
      </delivery-rules>
      <emails>
        <email>example-shop@yandex.ru</email>
      </emails>
      <phones>
        <phone>+7 (401) 212-22-32 #123</phone>
      </phones>
      <region id="22" name="Калининград" type="CITY">
        <parent id="121022" name="Городской округ Калининград" type="REPUBLIC_AREA">
          <parent id="10857" name="Калининградская область" type="REPUBLIC">
            <parent id="17" name="Северо-Западный федеральный округ" type="COUNTRY_DISTRICT">
              <parent id="225" name="Россия" type="COUNTRY"/>
            </parent>
          </parent>
        </parent>
      </region>
      <working-schedule work-in-holiday="false">
        <schedule-items>
          <schedule-item start-day="MONDAY" end-day="FRIDAY" start-time="09:00" end-time="19:00"/>
          <schedule-item start-day="SATURDAY" end-day="SATURDAY" start-time="10:00" end-time="16:00"/>
        </schedule-items>
      </working-schedule>
    </outlet>
  </outlets>
  <pager current-page="1" from="1" page-size="1" to="1"/>
</response>