Добавление / изменение продуктов для заказов. Продукты можно создавать заранее, или они создаются автоматически при добавлении в заказ. Также, при добавлении в заказ мы можем указывать свойства продукта, либо артикул продукта, если продукт с данным артикулом заведен заранее.
| Поле | Описание | Тип, возм. значения |
|---|---|---|
| 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¶m2=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}
Архивация продукта - аналог процедуры удаления продукта. Продукт удалить невозможно, т.к. он может быть связан с заказами и чеками. Архивация скроет продукт из списков продуктов, если он уже не используется. Продукт можно восстановить из архива, см. изменение продукта.