Получить информацию о точке продаж

Возвращает подробную информацию о точке продаж.

Формат запросаФормат запроса

GET https://api.ofd.yandex.net/{v1}/retail_points/{id}

• v1

  Номер версии API ОФД.

• id

  Идентификатор точки продаж в системе Яндекс ОФД. Является уникальным в рамках компании.

Заголовок запросаЗаголовок запроса

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

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

Формат ответаФормат ответа

{
    "name": "{string}",
    "alias": "{string}",
    "address": "{string}",
    "address_parts": {
      "postal_code": "{string}",
      "region": {number},
      "city": "{string}",
      "area": "{string}",
      "settlement": "{string}",
      "street": "{string}",
      "house": "{string}",
      "block": "{string}",
      "building": "{string}",
      "flat": "{string}"
    },
    "company_id": {number},
    "client_id": {number},
    "fns": "{string}",
    "id": {number},
    "is_internet_payment": {boolean},
    "is_delivery_service": {boolean}
}

• name

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

• alias

  Название точки продаж, которое будет отображаться в Личном кабинете. Если параметр не задан, в Личном кабинете отображается значение параметра name.

• address

  Юридический адрес компании в формате одной строки.

• address_parts

  Юридический адрес компании.

  • postal_code

    Почтовый индекс.

  • region

    Код региона.

  • city

    Город.

  • area

    Область.

  • settlement

    Поселение.

  • street

    Улица.

  • house

    Дом.

  • block

    Корпус.

  • building

    Строение.

  • flat

    Квартира.

• company_id

  Идентификатор компании системе Яндекс ОФД.

• client_id

  Идентификатор клиента, зарегистрировавшего компанию в системе Яндекс ОФД.

• fns

  Код ИФНС, в которой компания поставлена на учет.

• id

  Идентификатор точки продаж в системе Яндекс ОФД. Является уникальным в рамках компании.

• is_internet_payment

  Является интернет-магазином.

• is_delivery_service

  Используется для развозной торговли или при доставке курьером.

Коды ответаКоды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

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

Метод и адрес:

GET https://api.ofd.yandex.net/v1/retail_points/729

Заголовки запроса:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae

curl -X GET \
  https://api.ofd.yandex.net/v1/retail_points/729 \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca'

Ответ:

{
    "address_parts": {
        "flat": "",
        "area": "",
        "building": "",
        "postal_code": "119311",
        "city": "Москва",
        "block": "5",
        "region": 77,
        "street": "ул Строителей",
        "settlement": "",
        "house": "4"
    },
    "company_id": 587,
    "fns": "7736",
    "id": 729,
    "client_id": 88,
    "alias": "Магазин на Минском",
    "address": "119311, Москва, ул Строителей, д 4, к 5",
    "name": "ТЦ 2",
    "is_delivery_service": false,
    "is_internet_payment": true
}