Изменить информацию о точке продаж

Изменяет параметры точки продаж в системе Яндекс.ОФД.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа
  4. Пример запроса

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

PATCH https://api.ofd.yandex.net/{v1}/retail_points/{id}
Path-параметры
v1Номер версии API ОФД.
idИдентификатор точки продаж в системе Яндекс.ОФД. Является уникальным в рамках компании.

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

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

Заголовок Значение
X-Yandex-Key <аутентификационный ключ>
X-OFD-Key <авторизационный ключ>
Content-Type application/json

Тело запроса

Обязательным является параметр fns или address/address_parts.

{
    "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}"
  },
    "fns": "{string}",
    "company_id": {number},
    "client_id": {number},
    "is_internet_payment": {boolean},
    "is_delivery_service": {boolean}
}
name

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

alias

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

address *

Юридический адрес компании в формате одной строки. Обязателен, если не задан параметр fns или address_parts.

address_parts *

Юридический адрес компании. Обязателен, если не задан параметр fns или address.

postal_code

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

region

Код региона.

city

Город.

area

Область.

settlement

Поселение.

street

Улица.

house

Дом.

block

Корпус.

building

Строение.

flat

Квартира.

fns *

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

company_id

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

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

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

is_delivery_service

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

Обязательный параметр

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

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

{
    "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}"
  },
    "fns": "{string}",
    "company_id": {number},
    "client_id": {number},
    "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

Квартира.

fns

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

company_id

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

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

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

is_internet_payment

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

is_delivery_service

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

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

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

PATCH https://api.ofd.yandex.net/v1/retail_points/729
Заголовки:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
    "fns": "7705",
    "name": "ТЦ 1+1"
}
Пример запроса в формате cURL
curl -X PATCH \
  https://api.ofd.yandex.net/v1/retail_points/729 \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
        "fns": "7705",
        "name": "ТЦ 1+1"
}'

Ответ:

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