Функция работы с продуктами

Добавление / изменение продуктов для заказов. Продукты можно создавать заранее, или они создаются автоматически при добавлении в заказ. Также, при добавлении в заказ мы можем указывать свойства продукта, либо артикул продукта, если продукт с данным артикулом заведен заранее.

Объект продукта

ПолеОписаниеТип, возм. значения
idСистемный идентификатор продуктаЦелое число
org_idСистемный идентификатор организацииЦелое число
ext_idАртикул, уникальный внешний идентификатор продуктастрока
prod_nameНаименование продуктаСтрока
prod_quantЕдиница измерения продуктаСтрока
prod_typeТип продуктаЗначение из списка "Тип товара"
prod_priceЦена продуктаЦелое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точка
prod_vatНДС для продуктаЗначение из списка "Тип НДС для товара"
archiveПризнак, является ли товар архивным0 или 1

Получение списка продуктов

GET https://vsevkassu.ru/api/v1/store/product?param1=value1&param2=value2

Команда возвращает массив объектов касс, выбранных по заданным параметрам. Таблица параметров:

ПараметрОписаниеТип, возможные значенияОбяз.
ext_idАртикул, уникальный внешний идентификатор продукта (точное совпадение)СтрокаНет
prod_nameНаименование продукта (поиск по подстроке)СтрокаНет
prod_typeТип продуктаЗначение из списка "Тип товара"Нет
prod_price_fromЦена более чемЦелое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точкаНет
prod_price_toЦена менее чемЦелое или вещественное положительное число, до 2 десятичных разрядов, разделитель разрядов точкаНет
archiveПоказывать только архивные товары1Нет
offsetСменещениеЦелое числоНет

По умолчанию возвращается не более 50 объектов. Для получения большего количества, используйте смещение.

Пример: 

GET https://vsevkassu.ru/api/v1/store/product?prod_name=теле
[
    {
        "id": 1,
        "org_id": 1,
        "ext_id": "1",
        "prod_name": "телевизор",
        "prod_quant": "шт",
        "prod_type": 1,
        "prod_price": "10000.00",
        "prod_vat": 6,
        "archive": 0
    },
    {
        "id": 2,
        "org_id": 1,
        "ext_id": "2",
        "prod_name": "телефон",
        "prod_quant": "час",
        "prod_type": 1,
        "prod_price": "5000.00",
        "prod_vat": 6,
        "archive": 0
    }
]

Получение одного продукта по идентификатору

GET https://vsevkassu.ru/api/v1/store/product/{id}

Возвращает полный объект продукта по его системному идентификатору

Пример: 

GET https://vsevkassu.ru/api/v1/store/product/1
{
     "id": 1,
     "org_id": 1,
     "ext_id": "1",
     "prod_name": "телевизор",
     "prod_quant": "шт",
     "prod_type": 1,
     "prod_price": "10000.00",
     "prod_vat": 6,
     "archive": 0
}

Создание продукта

PUT https://vsevkassu.ru/api/v1/store/product

Метод создает новый продукт по указанным параметрам. В качестве параметров в теле запроса передается JSON-объект продукта.

Пример: 

PUT https://vsevkassu.ru/api/v1/store/product
{
     "ext_id": "1",
     "prod_name": "монитор",
     "prod_quant": "шт",
     "prod_type": 1,                //товар
     "prod_price": "10000.00",
     "prod_vat": 6            //без ндс
}

В ответ отдается объект созданного продукта при успешном создании с присвоенным системным id, либо ошибка создания.

Изменение продукта

POST https://vsevkassu.ru/api/v1/store/product/{id}

Функция изменяет поля продукта с идентификатором id, переданные в объекте в теле запроса. Список полей, которые можно изменить: 

{
     "ext_id": "1",
     "prod_name": "монитор",
     "prod_quant": "шт",
     "prod_type": 1,
     "prod_price": "10000.00",
     "prod_vat": 6 
}

Также, для отмены архивации продукта, можно передать 

{
   "archive" : 0
}

Архивация продукта

DELETE https://vsevkassu.ru/api/v1/store/product/{id}

Архивация продукта - аналог процедуры удаления продукта. Продукт удалить невозможно, т.к. он может быть связан с заказами и чеками. Архивация скроет продукт из списков продуктов, если он уже не используется. Продукт можно восстановить из архива, см. изменение продукта.