local_shippingSupplier. Поставщики

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

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

GET https://[компания].myvirtualpos.ru/api/supplier?apikey=MySecret&type_id=2

Условия объединяются по «и». Без параметров возвращаются все поставщики одним ответом; постраничной выдачи нет.

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

Основное

Реквизиты и контакты

Настройки

{
  "success": 1,
  "type": "supplier",
  "count": 1,
  "suppliers": [
    {
      "supplier": {
        "id": 151,
        "name": "Мой поставщик",
        "legal_name": "ООО «Мой поставщик»",
        "inn": "7700000000",
        "kpp": "770001001",
        "address": null,
        "phone": "+7 900 000-00-01",
        "email": "info@example.com",
        "www": null,
        "created_date": "2026-09-26 10:45:53",
        "created_by": null,
        "last_update_date": "2026-09-26 10:45:54",
        "last_update_by": null,
        "type_id": 2,
        "code": null,
        "OKPO": null,
        "OKONH": null,
        "corraccount": null,
        "bankaccount": null,
        "BIK": null,
        "bank_name": null,
        "status": null,
        "delivaddress": null,
        "external_id": "S-151",
        "price_coef": "1.200",
        "pricelist_life_length": 0,
        "znak_sys_id": null,
        "znak_branch_id": null,
        "chief_first_name": "Иван",
        "chief_last_name": null,
        "is_supplier": 1,
        "is_bank": 0,
        "is_buyer": 0,
        "is_individual": 0,
        "organisation_id": null,
        "customer_id": null,
        "type_name": "Внешний поставщик"
      }
    }
  ]
}

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>supplier</type>
  <count>1</count>
  <suppliers>
    <supplier>
      <id>151</id>
      <name>Мой поставщик</name>
      <inn>7700000000</inn>
      <!-- остальные поля поставщика -->
      <type_name>Внешний поставщик</type_name>
    </supplier>
  </suppliers>
</root>

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

POST https://[компания].myvirtualpos.ru/api/supplier/update?apikey=MySecret&external_id=S-151&create_if_not_exist=1
name=Мой поставщик&inn=7700000000&kpp=770001001&is_supplier=1

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

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

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