storeWarehouse. Точки продаж

Методы для работы со справочником точек продаж (магазинов и складов): получение списка, создание и изменение.

Удаления точек продаж через API нет.

GET https://[компания].myvirtualpos.ru/api/warehouse?apikey=MySecret&fields=organisation_name

Условия объединяются по «и». Без параметров возвращаются все точки продаж одним ответом. Если указано неизвестное поле в fields, метод вернёт ошибку со списком допустимых значений.

Пустые значения в JSON приходят как null, в XML — как пустой элемент.

Основное

Настройки

{
  "success": 1,
  "type": "warehouse",
  "count": 1,
  "warehouses": [
    {
      "warehouse": {
        "open_time": "10:00:00",
        "close_time": "21:00:00",
        "id": 6,
        "number": "5",
        "name": "Точка на Тверской",
        "active": 1,
        "address": "г. Москва, ул. Тверская, д. 3",
        "phone": "+7 900 000-00-01",
        "headquerter_id": 0,
        "created_date": "2019-06-06 17:25:12",
        "created_by": 3,
        "last_update_date": "2026-09-01 10:34:46",
        "last_update_by": 23,
        "flag24hours": 0,
        "lat": "55.76000000000000",
        "lon": "37.61000000000000",
        "minusale": 1,
        "location_id": 8,
        "external_id": "WH-6",
        "show_in_shop": 1,
        "organisation_id": 2,
        "vat_mandatory_flag": 0,
        "manager_user_id": 3,
        "primary": 0,
        "main_store_id": null,
        "znak_branch_id": "",
        "sbp_merchant_id": null,
        "location_name": "Москва"
      }
    }
  ]
}

В примере опущены пустые гибкие поля attribute1…attribute15. Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>warehouse</type>
  <count>1</count>
  <warehouses>
    <warehouse>
      <open_time>10:00:00</open_time>
      <close_time>21:00:00</close_time>
      <id>6</id>
      <name>Точка на Тверской</name>
      <!-- остальные поля точки продаж -->
      <location_name>Москва</location_name>
    </warehouse>
  </warehouses>
</root>

Если ничего не найдено, метод возвращает успешный ответ с count равным 0 и пустым списком.

POST https://[компания].myvirtualpos.ru/api/warehouse/update?apikey=MySecret&external_id=WH-6&create_if_not_exist=1
name=Точка на Тверской&address=г. Москва, ул. Тверская, д. 3&location_name=Москва

Точка продаж ищется по id, а если он не указан — по external_id. Если точка не найдена, а передан create_if_not_exist=1, создаётся новая. Изменяются только переданные параметры.

Остальные поля точки продаж (например, active, organisation_id, show_in_shop) через API не меняются: настраивайте их в панели управления.

{"success":1,"id":"17","isnew":"1"}

Ошибка авторизации и общие ошибки описаны в статье Общие сведения. Ошибки приходят с кодом HTTP 200 и success равным 0: