Получить список точек продаж
Внимание
Новые ключи временно не выпускаются в связи с обновлением продукта.
Возвращает список точек продаж.
Формат запроса
GET https://api.ofd.yandex.net/{v1}/retail_points
? [company_ids=<number>]
& [limit=<integer>]
& [offset=<integer>]
Номер версии API ОФД.
Идентификаторы компаний, по которым запрашиваются точки продаж.
Максимальное количество объектов, возвращаемое в ответе.
Смещение от начала списка объектов.
-
- v1
- Номер версии API ОФД.
-
- company_ids
- Идентификаторы компаний, по которым запрашиваются точки продаж.
-
- limit
- Максимальное количество объектов, возвращаемое в ответе.
-
- offset
- Смещение от начала списка объектов.
Заголовок запроса
Заголовки запроса должны содержать ключи (см. раздел Доступ к API):
| Заголовок | Значение |
|---|---|
X-Yandex-Key |
<аутентификационный ключ> |
X-OFD-Key |
<авторизационный ключ> |
Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.
Формат ответа
[
{
"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
Заголовки запроса:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
https://api.ofd.yandex.net/v1/retail_points \
-H 'x-ofd-key: eka...b17eae' \
-H 'x-yandex-key: 74f...e8ca'
Ответ:
[
{
"address_parts": {
"flat": "",
"area": "",
"building": "",
"postal_code": "105094",
"city": "Москва",
"block": "",
"region": 77,
"street": "ул Новая",
"settlement": "",
"house": "5"
},
"company_id": null,
"fns": "7705",
"id": 728,
"client_id": 88,
"alias": "Магазин на Каширском",
"address": "105094, Москва, ул Новая, д 5",
"name": "ТЦ 1",
"is_delivery_service": false,
"is_internet_payment": false
},
{
"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
}
]