Пункты выдачи товаров магазина

Описание

GET /{version}/shops/{id}/outlets

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

Ресурс является списочным.

URL ресурса:

https://api.content.market.yandex.ru/{version}/shops/{id}/outlets

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

Параметр Положе­ние Тип Обяза­тельность Описание
version PATH Enum Да

Версия API.

id PATH Int64 Да

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

fields QUERY Enum list Нет

Поля точек продажи, которые попадут в выдачу

Возможные значения:
  • OFFER — Информация о товарнном предложении, соответствующем точке продажи
  • OFFER_ACTIVE_FILTERS — активные фильтры.
  • OFFER_CATEGORY — информация о категории предложения.
  • OFFER_DELIVERY — информация о доставке.
  • OFFER_DISCOUNT — скидка.
  • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
  • OFFER_OUTLET — информация о точке выдачи производетеля.
  • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
  • OFFER_PHOTO — фото предложения.
  • OFFER_SHOP — магазин от которого поступило предложенение.
  • OFFER_VENDOR — информация о поставщике.
  • SHOP — Информация о магазине, сортировка по полезности отзыва
  • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
  • SHOP_RATING — рейтинг магазина.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
  • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_SUPPLIER, OFFER_VENDOR
  • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
  • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
format QUERY Enum Нет

Формат выходных данных.

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .
Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1

Значение по умолчанию: 1.
Параметры сортировки
how QUERY Enum Нет

Направление сортировки.

Возможные значения:
  • ASC — по возрастанию;
  • DESC — по убыванию.
Значение по умолчанию: Зависит от поля, по которому сортируем (так по цене сортировка по возрастанию, а по популярности по убыванию).
sort QUERY Enum Нет

Тип сортировки товарных предложений

Возможные значения:
  • DATE — сортировка по дате.
  • DELIVERY_TIME — сортировка по времени доставки.
  • DISCOUNT — сортировка по размеру скидки.
    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).
  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).
  • NOFFERS — сортировка по количеству предложений
  • OPINIONS — сортировка по количеству отзывов.
  • POPULARITY — сортировка по популярности.
  • PRICE — сортировка по цене.
  • QUALITY — сортировка по рейтингу.
  • RATING — сортировка по рейтингу.
  • RELEVANCY — сортировка по релевантности.
Значение по умолчанию: RELEVANCY.
Гео-координаты пользователя, для определения региона
Ограничение. Оба парметра должны быть определены совместно. Не допускается указывать один без другого.
latitude QUERY Double Нет

Широта

Ограничения:
  • Минимальное значение: -90.0, максимальное значение: 90.0.

longitude QUERY Double Нет

Долгота

Ограничения:
  • Минимальное значение: -180.0, максимальное значение: 180.0.

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

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

{
  "status" : "{enum}",
  "context" : {
    "region" : {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        //Содержимое объекта
      }
    },
    "currency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "alternateCurrency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "page" : {
      "number" : {int32},
      "count" : {int32},
      "total" : {int32},
      "last" : {boolean}
    },
    "warnings" : [
      {
        "type" : "{string}",
        "code" : "{string}",
        "message" : "{string}"
      },
      ...
    ],
    "id" : "{string}",
    "time" : "{date}",
    "link" : "{string}",
    "marketUrl" : "{string}"
  },
  "outlets" : [
    {
      //Содержимое объекта
    },
    ...
  ]
}

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

Параметр для формата JSON Параметр для формата XML Тип Описание
status status

Enum

Статус обработки запроса.

Возможные значения:
  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

context context

Object

Контекст обработки запроса.

outlets outlets

Object list

Список торговых точек / пунктов выдачи товара

Пункт выдачи

result-context-v2 Параметры, вложенные в context
id id

String

Уникальный идентификатор запроса.

time time

Date

Дата и время выполнения запроса в формате ISO 8601.

link link

String

Ссылка на текущий запрос.

marketUrl marketUrl

String

Ссылка на Яндекс.Маркет.

region region

Object

Информация о регионе запроса.

currency currency

Object

Валюта запроса.

alternateCurrency alternateCurrency

Object

Альтернативная валюта запроса.

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

Список предупреждений, возникших при обработке запроса.

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

region-v2 Параметры, вложенные в context/region
id id

Int32

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

name name

String

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

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

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

  • CITY — город.

  • VILLAGE — село.

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

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

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

  • AIRPORT — аэропорт.

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

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

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

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

country country

Object

Страна, к которой относится регион.

Регион

currency-v2 Параметры, вложенные в context/currency, context/alternateCurrency
id id

String

Код валюты.

name name

String

Название валюты.

page-info Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

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

total total

Int32

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

last last

Boolean

Признак последней страницы.

warning Параметры, вложенные в context/warnings
type type

String

Тип предупрежедния.

code code

String

Код предупреждения.

message message

String

Сообщение с описанием предупреждения.

Возможные ошибки

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.