Создать новую точку продаж

Создает новую точку продаж в системе Яндекс ОФД.

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

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

• v1

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

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

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

Тело запросаТело запроса

Обязательными являются параметр name, а также 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}"
    },
    "is_internet_payment": {boolean},
    "is_delivery_service": {boolean},
    "fns": "{string}",  
    "company_id": {number}
  }

• name *

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

• alias

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

• address *

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

• address_parts *

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

  • postal_code

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

  • region

    Код региона.

  • city

    Город.

  • area

    Область.

  • settlement

    Поселение.

  • street

    Улица.

  • house

    Дом.

  • block

    Корпус.

  • building

    Строение.

  • flat

    Квартира.

• is_internet_payment

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

• is_delivery_service

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

• fns

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

• company_id

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

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

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

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

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

• name

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

• alias

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

• address

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

• address_parts

  Юридический адрес компании. - postal_code: Почтовый индекс. - region: Код региона. - city: Город. - area: Область. - settlement: Поселение. - street: Улица. - house: Дом. - block: Корпус. - building: Строение. - flat: Квартира.

• is_internet_payment

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

• is_delivery_service

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

• fns

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

• company_id

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

• id

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

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

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

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

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

POST https://api.ofd.yandex.net/v1/retail_points

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
  "name": "ТЦ 1",
  "alias": "Магазин на Каширском",
  "address": "Москва, ул.Новая, 5",
  "is_internet_payment": false,
  "is_delivery_service": false,
  "fns": "7705"
}

curl -X POST \
  https://api.ofd.yandex.net/v1/retail_points \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
  "name": "ТЦ 1",
  "alias": "Магазин на Каширском",
  "address": "Москва, ул.Новая, 5",
  "is_internet_payment": false,
  "is_delivery_service": false,
  "fns": "7705"
}'

Ответ:

{
    "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
}