QUINCE API. Склади

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


/store/list	Отримання списку складів
/store/add	Створення нового склада
/store/update	Внесення змін даних склада
/store/folder/list	Отримання списку папок
/store/folder/add	Створення нової папки
/store/folder/update	Внесення змін до папки

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

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

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

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


filter Тип: object (необов'язковий)	Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
	ParentFolder - Id батьківської папки. Необов'язковий параметр. <br>Для отримання складів, які не належать до жодної з папок, тобто не мають прив'язки до папки, потрібно вказувати значення null.
	Id - ідентифікатор склада. Необов'язковий параметр
page Тип: integer (необов'язковий)	Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.

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

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

Значення полей складів, що повертаються методом:


Id	Ідентифікатор склада
Name	Назва склада (string)
ParentFolder	ID батьківської папки (integer)
Memo	Коментар (string)

Приклад:

Запит:

{
    "filter": {
        "ParentFolder": 110
    },
    "page": 1
}

Результат:

{
    "success": true,
    "data": [
        {
            "Id": 111,
            "ParentFolder": 110,
            "Name": "склад_1",
            ...
        },
        ...
    ]
}

Створення або оновлення склада

Метод створення склада(ів): /api/v2/store/add

Метод оновлення склада(ів): /api/v2/store/update

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

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

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


array Тип: масив (Обов'язковий)	Кожен товар в масиві являє собою об'єкт з переліком полів. Доступні поля:
	id Ідентифікатор товару. Враховується та є обов'язковим тільки для методу /store/update
	Name Назва товару (string)
	ParentFolder ID батьківської папки (integer)
	Memo Коментар (string)

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

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


success	true або false
data	Масив ідентифікаторів створених складів
error	Код та зміст помилки (вказується, якщо success = false)

Приклад:

Запит:

{
    "array": [
        {
            "Name": "Новий_склад",
            "Memo": "коментар до нового склада",
            "ParentFolder": "110",
            ...
        },
        ...
    ]
}

Результат:

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

Отримання списку папок

Назва методу: /api/v2/store/folder/list

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

Розмір сторінки фіксований і дорівнює 100 елементам.

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


filter Тип: object (необов'язковий)	Доступні поля для фільтрації (Фільтр завжди використовує логіку “AND“):
	Id - ідентифікатор папки. Необов'язковий параметр
page Тип: integer (необов'язковий)	Якщо в запиті не передати, за замовчуванням буде встановлена перша сторінка.

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

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

Приклад:

{
    "success": true,
    "data": [
        {
            "Id": 118,
            "Name": "Folder_123"
        },
        ...
    ]
}

Створення або оновлення папки

Метод створення папки(ок): /api/v2/store/folder/add

Метод оновлення папки(ок): /api/v2/store/folder/update

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

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

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


array Тип: масив (Обов'язковий)	Кожна папка в масиві являє собою об'єкт з переліком полів. Доступні поля:
	Id Ідентифікатор папки. Враховується та є обов'язковим тільки для методу /store/folder/update
	Name Назва папки (string)

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

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


success	true или false
data	Масив ідентифікаторів створених папок для методу /store/folder/add або масив ідентифікаторів оновлених папок для методу /store/folder/update
error	Код та зміст помилки (вказується, якщо success = false)

Приклад:

Запит:

{
    "array": [
        {
            "Id": 110,
            "Name": "Directory_111"
        },
      ...
    ]
}

Результат:

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

Оновлено: 15/07/2022