QUINCE API. Типи цін
Список методів
| Метод | Опис |
|---|---|
/api/v2/price_type/list | Отримання списку типів цін |
/api/v2/price_type/add | Створення типів цін |
/api/v2/price_type/update | Оновлення типів цін |
Отримання списку типів цін
Назва методу: /api/v2/price_type/list
Повертає список типів цін. Для навігації використовується номер сторінки page. Розмір сторінки фіксований і дорівнює 100 елементам.
Параметри запиту
| Поле | Тип | Опис |
|---|---|---|
filter | object | Необов’язковий фільтр. Поля фільтра працюють з логікою AND. |
filter.Id | integer | Ідентифікатор типу ціни. |
filter.Archive | boolean | Ознака повернення архівних типів цін. |
filter.MobileApp | boolean | Якщо true, API використовує збільшений ліміт вибірки. |
page | integer | Номер сторінки. Якщо не передати, використовується перша сторінка. |
Основні поля відповіді
| Поле | Опис |
|---|---|
Id | Ідентифікатор типу ціни. |
Name | Назва типу ціни. |
Memo | Коментар. |
Приклад запиту
{
"filter": {
"Id": 113
},
"page": 1
}
Створення та оновлення типів цін
Назва методу створення: /api/v2/price_type/add
Назва методу оновлення: /api/v2/price_type/update
Методи додають або оновлюють типи цін пакетами до 100 елементів. Для /api/v2/price_type/add обов’язкові Name і Currency, а переданий Id ігнорується. Для /api/v2/price_type/update поле Id обов’язкове. Якщо переданий Id не знайдено, API повертає success: false, помилку Execution terminated. Bad Ids. і список проблемних Id.
Параметри запиту
| Поле | Опис |
|---|---|
array | Масив типів цін. Обов’язковий. |
array[].Id | Ідентифікатор типу ціни. Обов’язковий для /api/v2/price_type/update. |
array[].Name | Назва типу ціни. |
array[].Currency | Валюта типу ціни. Обов’язкова для /api/v2/price_type/add. |
array[].Memo | Коментар. |
Формат відповіді
| Поле | Опис |
|---|---|
success | true або false. |
data | Масив ідентифікаторів створених або оновлених типів цін. |
error | Код і текст помилки, якщо success = false. |