QUINCE API. Ціни товарів
Список методів
| Метод | Опис |
|---|---|
/api/v2/price/list | Отримання списку цін |
/api/v2/price/add | Створення цін |
/api/v2/price/update | Оновлення цін |
Отримання списку цін
Назва методу: /api/v2/price/list
Повертає список цін товарів і послуг. Для навігації використовується номер сторінки page. Розмір сторінки фіксований і дорівнює 100 елементам.
Параметри запиту
| Поле | Тип | Опис |
|---|---|---|
filter | object | Необов’язковий фільтр. Поля фільтра працюють з логікою AND. |
filter.PriceType | array | Ідентифікатори типів цін. Має бути масивом. |
filter.Product | array | Ідентифікатори товарів або послуг. Має бути масивом, максимум 400 елементів. |
filter.Date | string | Дата, на яку треба отримати ціни. Формат: yyyy-mm-dd. Якщо не передати, використовується поточна дата. |
filter.MobileApp | boolean | Якщо true, API використовує збільшений ліміт вибірки. |
page | integer | Номер сторінки. Якщо не передати, використовується перша сторінка. |
Якщо filter.Date, filter.PriceType або filter.Product передані в некоректному форматі, API повертає success: false з текстом помилки.
Основні поля відповіді
| Поле | Опис |
|---|---|
Id | Ідентифікатор ціни. |
Date | Дата початку дії ціни. |
PriceType | Ідентифікатор типу ціни. |
Product | Ідентифікатор товару або послуги. |
Price | Значення ціни. |
Currency | Код валюти. |
Приклад запиту
{
"filter": {
"PriceType": [110],
"Product": [204, 205]
},
"page": 1
}
Створення цін
Назва методу: /api/v2/price/add
Метод додає ціни пакетами до 100 елементів.
Параметри запиту
| Поле | Опис |
|---|---|
array | Масив цін. Обов’язковий. |
array[].Product | Ідентифікатор товару або послуги. Обов’язковий. |
array[].PriceType | Ідентифікатор типу ціни. Обов’язковий. |
array[].Date | Дата початку дії ціни у форматі yyyy-mm-dd. Обов’язкова. |
array[].Price | Значення ціни. Обов’язкове. |
Оновлення цін
Назва методу: /api/v2/price/update
Метод оновлює ціни пакетами до 100 елементів. Оновлення можна виконати двома способами:
- Передати
Idціни. - Передати комбінацію
ProductіPriceType. ЯкщоDateне передати, використовується поточна дата й час.
Якщо переданий Id не знайдено, пакет не оновлюється і API повертає перелік не знайдених ідентифікаторів.
Параметри оновлення за Id
| Поле | Опис |
|---|---|
array | Масив цін. Обов’язковий. |
array[].Id | Ідентифікатор ціни. Обов’язковий. |
array[].Date | Дата початку дії ціни. Якщо не передати, використовується поточна дата й час. |
array[].Price | Значення ціни. Обов’язкове. |
Параметри оновлення за товаром і типом ціни
| Поле | Опис |
|---|---|
array | Масив цін. Обов’язковий. |
array[].Product | Ідентифікатор товару або послуги. Обов’язковий. |
array[].PriceType | Ідентифікатор типу ціни. Обов’язковий. |
array[].Date | Дата початку дії ціни у форматі yyyy-mm-dd. |
array[].Price | Значення ціни. Обов’язкове. |
Формат відповіді для створення та оновлення
| Поле | Опис |
|---|---|
success | true або false. |
data | Масив ідентифікаторів створених або оновлених цін. |
error | Код і текст помилки, якщо success = false. |