Статті на: Документація з API

QUINCE API. Типи цін

Список методів


/price_type/list

Отримання списку типів цін

/price_type/add

Створення нового типу цін

/price_type/update

Внесення змін даних типу цін


Отримання списку типів цін


Назва методу: /price_type/list


Повертає список типів цін. Для навігації використовується номер сторінки (page).
Розмір сторінки фіксований і дорівнює 100 елементам.


Параметри запиту:


filter Тип: object (необов'язковий)

Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):

Id - ідентифікатор типу цін. Необов'язковий параметр

Archive - Ознака того, що треба повертати архівні елементи

page Тип: integer (необов'язковий)

Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.


Результат запиту:


Якщо в запиті фільтр відсутній, то повертається список типів цін у порядку зростання Id.


Поля типів цін, що повертаються методом:


Id

Ідентифікатор типу цін

Name

Назва типу ціни (string)

Memo

Коментар (string)


Приклад:


Запит:


{
"filter": {
"ID": 113
},
"page": 1
}


Результат:


{
    "success": true,
    "data": [
        {
            "Id": 113,
            "Name": "Ціна партнера",
...
        },
        ...
]
}


Створення або оновлення типу цін


Метод створення типу цін(ів): /api/v2/price_type/add


Метод оновлення типу цін(ів): /api/v2/price_type/update


Методи додають або оновлюють типи цін. Максимальна кількість типів цін в одному пакеті - 100.


Параметри запитів у методів майже ідентичні. Тільки для методу /price_type/update обов'язковим є передача Id типу ціни для оновлення. Якщо в запиті відсутній Id, повертається помилка і жоден з типів цін не оновлюється.
Якщо в запиті Id переданий, але не знайдений в довіднику типів цін, жоден з типів цін також не оновлється і додатково повертається перелік незнайдених Id.


Параметри запиту:


array Тип: масив (Обов'язковий)

Кожен тип ціни в масиві являє собою об'єкт з наступними полями:

Id - Ідентифікатор типу ціни (int). Є обов'язковим тільки для методу /price\_type/update

Name Назва товару (string)

Memo Коментар (string)


Результат запиту:


Метод повертає масив:


success

true або false

data

Масив ідентифікаторів створених типів цін

error

Код та зміст помилки (вказується, якщо success = false)


Приклад:


Запит:


{
    "array": [
        {
            "Name": "Новий_тип_цін",
            "Memo": "коментар до нового типу цін",
...
        },
...
]
}


Результат:


{
"success": true,
    "data": [
        {
            "id": 116
        },
...
    ]
}

Оновлено: 22/11/2022